Welcome to the World of Technical Writing: A Guide for Newcomers
summary
Concrete takeaways and outcomes not cheerleading: built a mangra Docker extension plus blog posts and a maintained GitHub repo; documentation site work includes implemented dark mode with global CSS and image optimization via tinyjpg.com; core tools are Markdown HTML CSS and frameworks Docusaurus MkDocs Nextra and VS Code plus browser plugins; processes that stick are naming by issue/PR ID, treating docs as SEO assets, and using AI (KAI) only as a draft aid with strict human verification.
AI-written summary · about
chapters (17)
- 0:00Technical writing intro
- 3:09Why technical writing suits me
- 7:05Team collaboration skills
- 10:19Gathering info from experts
- 11:45Essential tools
- 14:40Choosing documentation frameworks
- 17:08Tools to streamline work
- 19:42File naming best practices
- 21:49Optimizing images
- 24:24AI for documentation
- 26:34Value of the tech writing community
- 28:47My journey in tech writing
- 30:11Q&A: Interview advice
- 32:40Q&A: Tech knowledge vs writing
- 34:53Q&A: Resources to improve
- 35:56Q&A: One tip for newcomers
- 37:43Closing remarks
related talks
40mWriting the Shipwreck
31m7 Essential Tips for the Enlightened Tech Writer
35mAn introduction to developer experience, and the role of a documentarian
34mFrom Graffiti Writer to Technical Writer
38mSeven habits of increasingly technical technical writers
39mSearch First-Writing for non-writers
22mWrite Prose, Not just programs
35mEngage or Die: Four Techniques for Writing Indispensible Docs