General Documentation Style

From Synfig Studio :: Documentation
Jump to: navigation, search
Line 1: Line 1:
 
<!-- Page info -->
 
<!-- Page info -->
 
{{Title|General Documentation Style}}
 
{{Title|General Documentation Style}}
{{Navigation|Writer_Documentation|Meta:Translation}}
+
{{Navigation|Writer_Documentation|Meta:Screen Shots}}
 
<!-- Page info end -->
 
<!-- Page info end -->
  
Line 22: Line 22:
 
* "Let's explain that..."  
 
* "Let's explain that..."  
  
{{Navigation|Writer_Documentation|Meta:Translation}}
+
{{Navigation|Writer_Documentation|Meta:Screen Shots}}

Revision as of 20:13, 24 May 2010

Navigation Navigation:  Writer Documentation>>


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 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..."
Navigation Navigation:  Writer Documentation>>