General Documentation Style
From Synfig Studio :: Documentation
Ohoservices (Talk | contribs) (Created page with '<!-- Page info --> {{Title|General Documentation Style}} {{Navigation|Writer_Documentation|Meta:Translation}} <!-- Page info end --> Here we describe some general points that ar…') |
Ohoservices (Talk | contribs) |
||
(3 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<!-- Page info --> | <!-- Page info --> | ||
{{Title|General Documentation Style}} | {{Title|General Documentation Style}} | ||
− | {{Navigation|Writer_Documentation|Meta: | + | {{Navigation|Writer_Documentation|Meta:ScreenShots}} |
<!-- Page info end --> | <!-- Page info end --> | ||
Line 9: | Line 9: | ||
== How to define more rules == | == How to define more rules == | ||
− | If you think that something is missing on this page, please use the Forum to discuss your request / proposal for a rule. | + | If you think that something is missing on this page, please use the Forum [http://synfig.org/forums/viewforum.php?f=25] to discuss your request / proposal for a rule. |
As soon as the discussion is reaching an accepted state everyone can request to ad this to te Writers' Doc. (and either let someone else do that or do it him/herself). | As soon as the discussion is reaching an accepted state everyone can request to ad this to te Writers' Doc. (and either let someone else do that or do it him/herself). | ||
Line 16: | Line 16: | ||
== We or I - who is talking to the reader? == | == We or I - who is talking to the reader? == | ||
− | We will use "we" when we talk to | + | We will use "we" when we talk to the reader. |
Examples: | Examples: | ||
* "We want to show you some more functions ...." | * "We want to show you some more functions ...." | ||
Line 22: | Line 22: | ||
* "Let's explain that..." | * "Let's explain that..." | ||
− | {{Navigation|Writer_Documentation|Meta: | + | {{Navigation|Writer_Documentation|Meta:ScreenShots}} |
Latest revision as of 20:16, 24 May 2010
Here we describe some general points that are important for the consistency of the documentation.
How to define more rules
If you think that something is missing on this page, please use the Forum [1] to discuss your request / proposal for a rule. As soon as the discussion is reaching an accepted state everyone can request to ad this to te Writers' Doc. (and either let someone else do that or do it him/herself).
We or I - who is talking to the reader?
We will use "we" when we talk to the reader. Examples:
- "We want to show you some more functions ...."
- "We just want to show you around a bit..."
- "Let's explain that..."