A few guidelines that help to make easier the documentation process.

2. ““The only irreplaceable capital an organization possesses is the
knowledge and ability of its people. The productivity of that
capital depends on how effectively people share their
competence with those who can use it.”
Andrew Carnegie. U.S. Steel. 1919.

3. 2
3
4
1

4. 1.
“To document or not to document, that is
the question”... Advantages and facts

5. It’s an ancestral requirement
The prehistoric man left us the legacy of his perspective of the world in
the inner walls of his refuge and all the civilizations that followed him
shared part of their knowledge in order to allow following humans to
understand where we come from and visualize future objectives

6. But from a practical perspective,
we also document because:

7. Documentation Advantages

8. 2.
The most useful and popular

15. 3.
An easy way to produce
documentation

17. Techwriting Essencial Guidelines
Style
○ Use present tense.
○ Use active voice.
○ Use second person (you).
○ Avoid 1st person (I, we, us).
○ Be gender neutral.
○ Use the appropriate tone.
○ Write for a global audience.
Abbreviations & Capitalization
○ Spell out unknown abbreviations
at the first instance.
○ Don't abbreviate product names.
○ Use sentence-style (lowercase)
capitalization in most instances.
Process
○ Focus on document’s goal.
○ Follow schemes.
○ Synthesize at maximum.
○ Write clearly.
○ Use short sentences.
○ Avoid acronyms.
○ Use images and diagrams
○ Ask for validation (structure,
content, grammar, etc.).
○ Add references, sources and
useful resources.

18. 4.

19. Resources & Links
●
●
●
○
○
○
○
○
○