- Achieving Clarity in Writing: Essential TechniquesWriting for clarity: Short sentences with one idea each, familiar simple words, active voice where subject acts, concrete examples illustrating...
- Documentation Systems ExplainedDocumentation systems: wikis for collaborative linked knowledge, README hierarchy from project to file level, and docs-as-code with version control.
- Editing for Clarity: Techniques for PrecisionEditing for precision eliminates ambiguity: Remove weasel words (seems, might, perhaps), specify quantities (many → 73%), clarify pronouns (it,...
- Exploring Documentation Debt: Causes and ConsequencesDocumentation debt: Docs lag behind reality when code changes but docs don't. Accumulates through rushed features, team turnover, and neglected...
- Knowledge Writing: Capturing and Sharing ExpertiseKnowledge writing captures expertise: explicit knowledge with documented steps and procedures, plus tacit knowledge including context and judgment...
- Overview of Technical Documentation Types and UsesTechnical documentation types: API docs (endpoints, parameters, examples), user guides (workflows, screenshots), architecture docs (system design,...
- Principles of Clear Writing for Effective CommunicationClear writing: one idea per sentence avoiding compound complexity, active voice with subject doing action, concrete nouns over abstractions, short...
- Technical Writing: Skills and Effective PracticesTechnical writing translates complex information into clear, usable documentation. Learn what technical writers do, key frameworks like Divio,...
- The Importance of Structure in Writing ExplainedWriting structure guides readers: Top-down starts with conclusion, bottom-up builds to conclusion, chronological follows time order,...
- The Science Behind Clear Writing: Techniques and PracticesClear writing principles backed by research: Flesch reading ease, plain language, the Pyramid Principle, George Orwell's 6 rules, and the specific...
- Understanding Knowledge Management in OrganizationsKnowledge management is how organizations capture, share, and preserve what they know. Learn about Nonaka's SECI model, tacit vs explicit...
- Writing Mistakes ExplainedCommon writing mistakes: burying the lead with main point last, passive voice obscuring actor, jargon overload, and vague pronouns like it or this.
- Writing for Decision MakersWriting for decision-makers: lead with recommendation, provide supporting evidence, quantify impact, address risks, specify next steps and timeline.