Putting the “tech” in technical writer
summary
Argues that the leap from WYSIWYG to docs-as-code is practical and concrete: demonstrates reading docx as a zipped XML file, editing SVGs as XML, and using plain text formats like Markdown to write. Shows a live workflow with Markdown + Hugo + GitHub Actions that builds a portfolio site, explains the key git commands and a git feature-branch + pull request review flow, and explains CI that rebuilds on push so previews appear automatically. Recommends learning just enough to contribute and documents toolchain choices.
AI-written summary · about
chapters (18)
- 0:00Start
- 0:18What Is Redoxlink
- 1:05Putting the Tech in Technical Writer
- 6:26Microsoft Word
- 12:04Tech Writers Processes and Workflows
- 13:12Version Control
- 15:40Github Flow
- 16:29Create Documentation
- 16:53Feature Branch
- 21:05Platform Agnostic
- 21:34Criticisms around Plain Text
- 22:39Enhanced Previews
- 22:54Previews
- 26:31Continuous Delivery with Documentation
- 29:07Tool Chain
- 39:05Translation or Localization
- 39:23Translation and Localization
- 40:47Content Reusability
related talks
47mThe Things You Don't Want to Write - Documentation
51mWriting the Darn Docs
38mThe Stuff You Don't Want to Write... Documentation
40mFrom resistance to adoption: navigating the challenges of docs-like-code
29mHumanizing Your Documentation
39mLower the Barrier of Entry: Empowering Non-writer Contributions To Docs
26mWhy Docs-as-Code Peer Review Should be Part of your Dev Cycle
40mDocumentation as User Experience