[opensuse-doc] LfL: Few Questions
Hello, I was wondering what the target grading was for readability? Also, is there not a common novell/suse/opensuse entity file for inclusion into all documents? Thanks. Thomas
Hi Thomas, welcome to opensuse-doc! :-) On Mittwoch, 16. Mai 2007, Thomas R. Jones wrote:
I was wondering what the target grading was for readability?
Well, I assume you mean for which readers we write, right? We try to target it to "normal users" but this term can be stretched. :) There are topics that are very system administrative, for example.
Also, is there not a common novell/suse/opensuse entity file for inclusion into all documents?
For LfL we have one file that includes every topic. Is that what you mean? Bye, Tom -- Thomas Schraitle ---------------------------------------------------------------------- SUSE LINUX GmbH >o) Documentation Specialist Maxfeldstrasse 5 /\\ 90409 Nuernberg _\_v http://en.opensuse.org/Documentation_Team --------------------------------------------------------------------- To unsubscribe, e-mail: opensuse-doc+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-doc+help@opensuse.org
On Wed, 2007-05-16 at 16:07 +0200, Thomas Schraitle wrote:
Hi Thomas,
welcome to opensuse-doc! :-)
On Mittwoch, 16. Mai 2007, Thomas R. Jones wrote:
I was wondering what the target grading was for readability?
Well, I assume you mean for which readers we write, right? We try to target it to "normal users" but this term can be stretched. :) There are topics that are very system administrative, for example. I was referring to educational level. I try as much as possible when authoring documentation to adhere to a baseline level. e.g. the target grade for readability formulas, kincaid, flesch, gunning-fog, etc....
Also, is there not a common novell/suse/opensuse entity file for inclusion into all documents?
For LfL we have one file that includes every topic. Is that what you mean? More with regards to urls, project titles, etc... I have written for fedora, and they have a common file that includes all project titles, urls and such for all community entities. Obviously this keeps references more consistent throughout the community contributions. Not to mention if a project were to change names or urls; it can be disseminated throughout all documentation with a simple change and then rebuild documents.
Does anything like that exist currently for opensuse-doc? If not, I would like to formally request such. I don't mind doing the coding/research to achieve a comprehensive and consistent resource for all authors. Let me know. I can work up a prototype if the community would be so inclined.
Bye, Tom
Hi, On Mittwoch, 16. Mai 2007, Thomas R. Jones wrote:
[...]
I was referring to educational level. I try as much as possible when authoring documentation to adhere to a baseline level. e.g. the target grade for readability formulas, kincaid, flesch, gunning-fog, etc....
Ahh ok. Thanks for the explanation, I was barking at the wrong tree. ;)
Also, is there not a common novell/suse/opensuse entity file for inclusion into all documents?
For LfL we have one file that includes every topic. Is that what you mean?
More with regards to urls, project titles, etc... I have written for fedora, and they have a common file that includes all project titles, urls and such for all community entities. Obviously this keeps references more consistent throughout the community contributions. Not to mention if a project were to change names or urls; it can be disseminated throughout all documentation with a simple change and then rebuild documents.
Does anything like that exist currently for opensuse-doc? If not, I would like to formally request such. I don't mind doing the coding/research to achieve a comprehensive and consistent resource for all authors. Let me know. I can work up a prototype if the community would be so inclined.
Ah, now it makes sense. Yes, we have an entity file[1] that is included in each topic. For example, you can find product names, the LfL URL, example users, etc. Bye, Tom ---- [1] https://forgesvn1.novell.com/svn/lfl/trunk/books/en/xml/entity-decl.ent -- Thomas Schraitle ---------------------------------------------------------------------- SUSE LINUX GmbH >o) Documentation Specialist Maxfeldstrasse 5 /\\ 90409 Nuernberg _\_v http://en.opensuse.org/Documentation_Team --------------------------------------------------------------------- To unsubscribe, e-mail: opensuse-doc+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-doc+help@opensuse.org
On Wednesday 16 May 2007 16:30, Thomas R. Jones wrote: Hi,
On Wed, 2007-05-16 at 16:07 +0200, Thomas Schraitle wrote:
On Mittwoch, 16. Mai 2007, Thomas R. Jones wrote:
Also, is there not a common novell/suse/opensuse entity file for inclusion into all documents?
For LfL we have one file that includes every topic. Is that what you mean?
More with regards to urls, project titles, etc... I have written for fedora, and they have a common file that includes all project titles, urls and such for all community entities. Obviously this keeps references more consistent throughout the community contributions. Not to mention if a project were to change names or urls; it can be disseminated throughout all documentation with a simple change and then rebuild documents.
Does anything like that exist currently for opensuse-doc?
xml/entity-decl.ent exists - it's what we use for the official manuals as well. It can, of course, be broadened with whatever we need. BTW: An openSUSE dictionary for aspell is also available - see common/aspell/ -- Regards Frank Frank Sundermeyer, Technical Writer, Documentation SUSE Linux Products GmbH, Maxfeldstr. 5, D-90409 Nuernberg Tel: +49-911-74053-0, Fax: +49-911-7417755; http://www.opensuse.org/ SUSE Linux Products GmbH, GF: Markus Rex, HRB 16746 (AG Nuernberg) "Reality is always controlled by the people who are most insane" Dogbert --------------------------------------------------------------------- To unsubscribe, e-mail: opensuse-doc+unsubscribe@opensuse.org For additional commands, e-mail: opensuse-doc+help@opensuse.org
participants (3)
-
Frank Sundermeyer -
Thomas R. Jones -
Thomas Schraitle