Docs

Planted 02022-09-13

There are two goals of documentation.

1. Knowledge extraction of domain experts
2. Knowledge transference to relevant people

Knowledge

The

to understand something, you must actively engage with it

Extraction

Domain

Shared reality Shared Language Ubiquitous Language Language Bugs

Experts

Cached Thoughts

Transference

Relevant people

References

• The Tacit Knowledge Series
• Why books donʼt work
• Write the docs
  • Documentation principles
  • Docs as Code
  • Choosing tools for documentation
• The Text Method for determining visual hierarchy
• Diátaxis: A systematic framework for technical documentation authoring.
• Doxa, Episteme, and Gnosis
• CSS Tricks: Technical Writing for Developers
  • Hacker news
• Presentation Zen
• Specification by Example
• Writing An Effective Tech Spec (video)
• Pull requests are a form of documentation