OS Documentation

[Guest]

Hi.
I need information and help on the following topics:

writing whitepapers
-need information on what types of things i should write about

articles
-need information on what types of things i should write about

tutorials
-need information on what types of tutotials people would like

faq's
- what are the most faq's about an os which ppl r likely to ask

os documentation
-such as analysi, design and etcc.

if you could provide information on how i shud create and present the information that would be helpful

thnx

[Tim]

If you need to write one of these, you'll know what to write.

If you don't know what to write then you don't need to write anything.

[jrfritz]

I think that stuff is needed after you OS is in it's version 1.0...since programmers will need info on how to program your OS and writing it when version 1.0 is complete leaves you to add ideas and change stuff.

[jrfritz]

Actually...I mean that I think that OS docs are needed once one part of the API is set up as standard...and won't change.

[Pype.Clicker]

When you find you have yourself difficulties to understand the what and the why of a package by reading it and feel the urge to print it on paper to find out what it does, then it's time to sketch a white paper about it ...
(imho)

As long as there's no implementation, it's pretty silly to spend time in encoding stuffes electronically: a paper and a pencil can do nice design job ... (unless you need to share these informations with other people across the Internet)

[DarylD]

I agree.

To be honest, in the early stages most OS projects are in quite a lot of flux. I know what my end goal is and how I would like everything to function but the nitty-gritty details can be worked out along route.

So, don't worry about it, just enjoy coding.

Oh, and if you are intending to share documentation and ideas at this design stage, beware of feature-creep before you have even written a line of code!! Its very easy to spend months designing without writing a single line of code.