developer.jelix.org is not used any more and exists only for history. Post new tickets on the Github account.
developer.jelix.org n'est plus utilisée, et existe uniquement pour son historique. Postez les nouveaux tickets sur le compte github.

Changes between Version 8 and Version 9 of en/doc-guidelines


Ignore:
Timestamp:
Aug 19, 2009, 8:55:40 PM (11 years ago)
Author:
afroxav
Comment:

some syntax changes

Legend:

Unmodified
Added
Removed
Modified
  • en/doc-guidelines

    v8 v9  
    33
    44== General writing ==
    5 There is simple trick that you use when writing documentation. You need to make sure that the content is reader-friendly, so avoid putting to many technical terms: don't talk about Unix sockets when talking of database, even if they are mentioned in the API. Write your documentation as if the reader remember only half of what he read on the preceding pages, but remembers everything from the current page. Be mindful, and don't over-simplify the documentation: advanced users won't like it.
     5There is simple trick that you use when writing documentation. You need to make sure that the content is reader-friendly, so avoid putting to many technical terms: don't talk about the how and the why of Unix sockets in detail when talking of PHP installation, even if they are mentioned in the API. Write your documentation as if the reader remembers only half of what he read on the preceding pages, and as if the user had only a very limited knowledge of technical terms. But be mindful, and don't over-simplify the documentation since advanced users won't like it.
    66
    77As always, be careful for grammar and spelling mistake. Write in regular, international english and don't use colloquial terms. Always preview your changes, to double check for errors.