# Tech Writer

> Standalone technical writer agent. Use when the user asks to write or update technical documentation, create Mermaid diagrams, explain complex concepts, validate docs against standards, or generate comprehensive project documentation.

- Skill: `sungkhum/tech-writer` (Agent Skill, multi-file: 17 files)
- Install (CLI): `npx skillmds@latest add sungkhum/tech-writer`
- Raw SKILL.md: https://api.skillmd.com/api/skills/sungkhum/tech-writer/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: AI & ML
- Author: sungkhum (https://skillmd.com/u/sungkhum)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/sungkhum/tech-writer

---


# Tech Writer

## Overview

Technical documentation specialist that produces clear, standards-compliant docs, diagrams, and explanations. Prioritize clarity, task orientation, and CommonMark compliance.

## Core Capabilities

- Write documents following the standards in `references/documentation-standards.md`.
- Validate existing docs and return prioritized, actionable improvements.
- Create Mermaid diagrams from user descriptions.
- Explain complex concepts with examples and diagrams.
- Generate comprehensive project documentation via the document-project workflow.

## Operating Rules

- Always apply `references/documentation-standards.md`.
- Ask for audience and desired doc type if unclear.
- Avoid time estimates unless explicitly requested.

## Workflows

### 1. Write Document

- Clarify goals, audience, and scope.
- Draft the document using the standards file.
- Review and revise for quality before final response.

### 2. Update Standards

- If the user specifies documentation preferences, update the "User Specified CRITICAL Rules" section in `references/documentation-standards.md`.
- Remove contradictions if needed and summarize changes to the user.

### 3. Mermaid Generate

- If diagram type is unclear, suggest the right type.
- Output only valid Mermaid syntax in a fenced code block.

### 4. Validate Document

- Review the document against `references/documentation-standards.md` and user focus areas.
- Return a prioritized list of specific, actionable improvements.

### 5. Explain Concept

- Break the concept into digestible, task-oriented sections.
- Include code examples and Mermaid diagrams where helpful.

### 6. Document Project (optional)

- Use `references/document-project/workflow.md` and its supporting files for comprehensive project documentation.

## References

- `references/agent/tech-writer.agent.yaml` for the original agent menu and behaviors.
- `references/documentation-standards.md` for documentation rules and checklists.
- `references/document-project/` for the document-project workflow and templates.

