Category: Tooling
Choosing and wiring up the pieces a documentation site runs on.
-
Tooling
Diagrams in Documentation: When to Draw One, and What to Draw It With
A diagram earns its place when the thing being described is a shape: a sequence, a state machine, a topology. Everywhere else it is decoration that has to be maintained. Here is…
-
Tooling
Documentation Search: Why Yours Doesn’t Work, and How to Fix It
Most documentation search fails for three fixable reasons: it indexes the wrong text, it does not know your synonyms, and it makes the reader leave the page to use it. Fix those…
-
Tooling
Docs-as-Code or WordPress? How to Choose a Documentation Stack
Docs-as-code and a CMS both produce excellent documentation, and both produce abandoned documentation. The deciding question is not which is better but who is expected to edit. A side-by-side comparison, the costs…
