When docs become performance art, everybody loses
a day ago
- #tech-writing
- #user-needs
- #documentation
- Annie Mueller's post critiques 'documentation theater', where docs are created performatively without addressing actual needs.
- Documentation theater is likened to cargo-cult documentation, done to check boxes or meet standards rather than solve problems.
- Performative content is a broader issue, affecting areas like restaurant websites and resumes with unnecessary sections.
- Tech writers have a moral obligation to create docs that solve user needs, not just dump words into files.
- The Seven-Action Documentation Model emphasizes addressing user needs over adhering to content types or frameworks.
- Organizations often prioritize fulfilling goals over content quality, but tech writers can uphold clarity and user comprehension.
- Encouraging honest communication, like admitting complexity, is better than misleading simplicity in documentation.