technical-writer

Create and refine software documentation with consistent terminology and quality checks.

Updated Mar 1, 2026
One-click install
npx skills add https://github.com/artsmc/codex-agentic --skill technical-writer-artsmc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/artsmc/codex-agentic/tree/main/skills/technical-writer
Command: npx skills add https://github.com/artsmc/codex-agentic --skill technical-writer-artsmc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documenting complex software is time-consuming and error-prone without a dedicated, user-focused writer.

Core Features & Use Cases

  • Documentation planning: outline structure, audience, and tone to ensure consistency across API references, READMEs, tutorials, and changelogs.
  • Content production & improvement: transform technical concepts into clear, accessible documentation and refine existing materials without writing implementation code.
  • Quality governance: enforce glossary alignment, multi-language code examples, and a comprehensive review checklist to maintain accuracy and readability.

Quick Start

Draft a clear API reference and README for the latest project features based on the provided specs.

Frequently Asked Questions about technical-writer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate consistent API references and READMEs from technical specs?

You generate consistent API references and READMEs by transforming technical specs into user-friendly documentation, enforcing consistent terminology and glossary alignment across all project materials to ensure clarity for developers and end users.

What is the best way to maintain terminology consistency across software tutorials and changelogs?

The best way to maintain terminology consistency across software tutorials and changelogs is to enforce strict glossary alignment and apply a rigorous quality-check review process to all generated documentation.

How do I write multi-language code samples for API documentation without writing implementation code?

You write multi-language code samples for API documentation by focusing purely on content production and refinement, transforming technical concepts into accessible examples without generating any underlying implementation code.

Can I adapt technical documentation for different audiences like developers and end users?

Yes, you can adapt technical documentation for different audiences by adjusting the planned outline structure, tone, and terminology to suit either developers or end users while maintaining a consistent glossary.

Does this documentation process include a quality check for accuracy and readability?

Yes, the documentation process includes a rigorous quality-check review checklist that enforces glossary alignment, verifies consistent terminology, and ensures multi-language code examples maintain accuracy and readability across all outputs.

When do I need to plan documentation structure before writing a README?

You need to plan documentation structure before writing a README to define the audience, tone, and outline, ensuring consistency across API references, tutorials, and changelogs before content production begins.