4 ms·
For this reason I would say you need to automate as much as possible. Maintaining quality documentation is expensive, and although much of it requires a human
by jsankey 15y ago
For this reason I would say you need to automate as much as possible. Maintaining quality documentation is expensive, and although much of it requires a human eye there should be plenty of opportunity for machie verification too.
For instance, code examples (snippets or sample projects) should be actually compiled and tested, automatically, every time the docs or the API itself changes. Think of it as CI for your documentation.