Documentation as Code (Explained to My Father)
summary
Introduces using AsciiDoc and the Asciidoctor toolchain to treat documentation like code: use versioning, builds and coder best practices (tests, DRY, KISS) instead of Word/SharePoint. Explains the advantages of AsciiDoc/Asciidoctor and concrete practices to improve writing, collaboration and publishing of docs.
AI-written summary · about
chapters (6)
- 0:00Introduction
- 2:31Treat docs as code
- 13:58AsciiDoc for content
- 26:19Git for docs
- 41:52Publish docs in multiple formats
- 47:58Q&A
related talks
47mDocumentation as code (explained to my dad)
25mDocumentation as Code, Where to Start?
50mContinuous and Automated Documentation Docs As Code in Practice
41mStop making fool of yourself about documentation
46mAsciidoctor: because writing docs does not have to suck
35mThe practical implementation of Documentation as Code
45mDocs as Code Fix a poor documentation culture in your organization
44mPushing documentation (so it doesn't hurt anymore)