4 ms·
Writing feels fluid to me when I think I know what I am talking about and I can imagine someone what parts of my writing someone wants to pay attention to. Whe
by afarrell 7y ago
Writing feels fluid to me when I think I know what I am talking about and I can imagine someone what parts of my writing someone wants to pay attention to.
When writing documentation, you often either:
1) Know the system very well -- So it is hard to know what the reader needs to know.
2) Don't know the system well at all -- so WTF do you write?
Documentation is better written as a pair between an engineer familiar with the system and an engineer who has self-confidence, passing familiarity with the languages, and no knowledge of the system.
Product idea: As two engineers pair-writing documentation, I want to turn on a product that records what we say and where the senior engineer navigates in the codebase into a very-rough first draft of documentation. Look at the Otter.ai API.