Documentation Strategy

From Open Source Ecology
Revision as of 17:04, 23 June 2012 by YK (talk | contribs) (Created page with "=What is Documentation= Documentation involves the saving of information for access at a later time. =Documentation Strategy Summary= A documenter should try to tell a compell...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

What is Documentation

Documentation involves the saving of information for access at a later time.

Documentation Strategy Summary

A documenter should try to tell a compelling, informative story that draws in the reader and efficiently communicates the desired information. Emphasis on content.

Well-connected stories are extremely effective to ease the learning curve for new readers through multiple concepts and relationships. Emphasis on continuity.

Experienced users often want to reference a particular section of a long story because they already know about or do not have the immediate time to go through the first half. Emphasis on navigability.

How can we achieve optimized content, continuity, and navigability?