Master JIRA APIs: Essential Documentation Tips
summary
Defines docs-as-code as mandatory: docs live in git, use the same editor and PR workflow as engineers, and a change never merges without content-design approval. Uses VS Code, Bitbucket inline edits, and a single-command build that spins a local web server via Atlas + DAC local preview so rendered HTML matches production. Runs weekly critiques, gathers thumbs-up/down feedback, and this quarter two contractors fixed 100+ issues from typos to full guide rewrites and rerouted Forge CLI inline help.
AI-written summary · about
chapters (10)
- 0:00Start
- 0:21Introduction to Our Process
- 1:34Working Methods Explained
- 5:31Writing Techniques Overview
- 10:16Previewing Our Content
- 13:15Review Process Insights
- 13:39Importance of Content Reviews
- 16:48Announcing New Changes
- 19:26Addressing Key Issues
- 22:35Interactive Q&A Session
related talks
25mBuilding Docs like Code: Continuous Integration for Documentation
44mPushing documentation (so it doesn't hurt anymore)
47mEngineering Documentation
35mBuilding Docs like Code: Continuous Integration for Documentation
45mDocs as Code Fix a poor documentation culture in your organization
23mWriting Good Documentation for Developers
22mDecomposition and beyond: frontend engineering at scale
42mEngineering Documentation