Mailinglist Archive: opensuse-doc (50 mails)

< Previous Next >
Re: [opensuse-doc] LfL: Few Questions
  • From: "Thomas R. Jones" <thomas.jones@xxxxxxxxxxxxxxxxxxxx>
  • Date: Wed, 16 May 2007 09:30:59 -0500
  • Message-id: <1179325859.4699.23.camel@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx>
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
> 
> 
< Previous Next >