Continuous Documentation
summary
Continuous documentation treats docs as code that updates every sprint, claiming Vidcaster moved implementation notes out of a sprawling README into a versioned Docs folder with links and now reflects UI and business-rule changes as they ship. It warns against putting more than three sections in README, using vague commands like “it just works,” or cultural and gendered phrasing, and recommends automated writing checks and writing for nontechnical readers so onboarding actually succeeds.
AI-written summary · about
chapters (5)
- 0:00Start
- 2:51Why Is It Important To Have Continues Documentation
- 3:23Common Pitfalls in Current Documentation Practices
- 5:03Can You Take Your Documentation and Give to a Non-Technical Person and Expect Them To Make Sense of It
- 6:26Race Related Phrases
related talks
18mContinuous Documentation Manifesto
25mBuilding Docs like Code: Continuous Integration for Documentation
29mContinuous Documentation: basics and advanced techniques
50mContinuous and Automated Documentation Docs As Code in Practice
35mThe practical implementation of Documentation as Code
47mEngineering Documentation
41mLong-term Documentation Maintenance
45mDocs or it didn't happen!