loopyluci/skills/technical-writing-documentation

Technical Writing Documentation

API docs, user guides, knowledge bases, and docs-as-code workflows

Trigger

Activate this skill when the user mentions:

• "technical-writing", "docs" workflows or issues
• Building, fixing, or optimizing technical writing documentation
• Questions about "technical-writing" best practices

Core Concepts

• Language-specific idioms and best practices
• Package/module organization
• Error handling and logging patterns
• Testing methodology (unit, integration, e2e)
• Build, lint, and format tooling

Step-by-Step Workflow

1. Setup — Initialize project, install dependencies, configure tooling

• Expected: Working dev environment

1. Implement — Write core logic following idiomatic patterns

• Expected: Functional code with passing tests

1. Test — Write and run tests covering happy path and edge cases

• Expected: All tests pass, >80% coverage

1. Review — Self-review for code quality, performance, security

• Expected: Clean, documented production-ready code

1. Deliver — Commit, document, and verify end-to-end

• Expected: Working feature with tests and docs

Tools & Technologies

• Language-specific package manager
• Test framework
• Linter/Formatter
• Build system
• Debugging tools

Best Practices

• Document decisions and rationale (ADRs, design docs, runbooks)
• Version everything - code, configs, data, and documentation
• Test incrementally; never claim passing without verification
• Respect domain-specific regulations and ethical standards
• Measure outcomes with meaningful metrics

Common Pitfalls

• Skipping error handling → Silent failures → Always handle errors explicitly
• Over-engineering → Unnecessary complexity → Add abstraction only when needed
• Missing tests → Regression bugs → Write tests alongside code

Tags

"technical-writing", "docs"

LoopyLuci/Skills - 2026-09-24