technical-writing

The Technical Writing skill is designed for engineers and quality practitioners who need to communicate complex technical concepts effectively. It moves beyond generic writing advice to focus on the 'show, don't tell' methodology, ensuring that every piece of content—whether documentation, API guides, or architectural deep-dives—provides measurable value. The skill enforces a structured writing framework, emphasizing reader-centric content that answers the 'why' and 'how' with precision, evidence, and transparency regarding trade-offs.

• Principles-based drafting: Focuses on leading with value, eliminating corporate jargon like 'leverage' or 'synergy,' and prioritizing specific, data-backed claims over fluff.

• Structured formatting: Implements a standardized blog and documentation architecture, including hooks for reader engagement, clear scanning headers, and explicit takeaways.

• Audience-specific tailoring: Adapts technical complexity based on the target reader—whether providing code-heavy implementation details for developers, risk-assessment heuristics for QE, or high-level business impact metrics for leadership.

• Automated review cycle: Integrates with the qe-quality-analyzer and qe-api-contract-validator agents to ensure that technical content remains technically accurate and consistent with the codebase.

• Editing rigor: Applies a strict checklist before publication, including clarity audits, code correctness verification, and conciseness trimming.

• Use this skill when generating READMEs, project wikis, internal post-mortems, or public-facing technical articles.

• Expect outputs to require clear, evidence-based inputs; if you are writing about a test strategy, provide metrics like bug detection rates or performance improvements.

• The skill is intended to bridge the gap between deep technical work and accessible knowledge, effectively turning engineering outcomes into high-utility, shareable content.

• Avoid using this skill for creative fiction or marketing-heavy copy that lacks technical substance; it is strictly optimized for professional, experience-driven technical communication.