Note that there are some explanatory texts on larger screens.

plurals
  1. PO
    primarykey
    data
    text
    <p>Many successful open source projects demonstrate how good online documentation can look like.</p> <p>Some aspects are:</p> <ul> <li>Up to date. If the documentation is not up to date anymore, it <em>may</em> become a show stopper.</li> <li>Many online documentations begin with some short tutorial. They show some key aspects from the software and keep the user aware and interested to dig deeper.</li> <li>Often HowTos or FAQs are very useful. Many users choose not to read documentations and just try it out. At some point the users are very likely to ask the same question over and over again. Be aware what the users may ask for and what they already have asked for.</li> <li>For the interested users, provide some in detailed information in a <em>core documentation</em>.</li> <li>Also consider to think about the audience of the documentation. As an author of documentation, I think it’s very useful to clearly state for which audience the documentation is for and what kind of knowledge they should already have. This forces me to be specific and concise. This way I may end up separating the documentation in different distinct parts, which makes the documentation very structured.</li> </ul> <p>If you already have a “1500-something pages tome like” documentation, you can <em>wrap</em> around some tutorials, HowTos and FAQs and that would spice up the documentation. When the software evolves, you can <em>refactor</em> the core documentation to a more readability.</p> <p>The most hard part is to keep the documentation up to date. Write the documentation with future changes in mind.</p>
    singulars
    1. This table or related slice is empty.
    plurals
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. VO
      singulars
      1. This table or related slice is empty.
    2. VO
      singulars
      1. This table or related slice is empty.
    3. VO
      singulars
      1. This table or related slice is empty.
    1. This table or related slice is empty.
 

Querying!

 
Guidance

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload