technical-writing

Write, edit, and review technical documentation, guides, tutorials, and articles in Markdown.

3|Updated Apr 8, 2025
One-click install
npx skills add https://github.com/ZanzyTHEbar/dragonarchy --skill technical-writing-zanzythebar
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: technical-writing
Source: https://github.com/ZanzyTHEbar/dragonarchy/tree/main/packages/opencode/.config/opencode/skills/technical-writing
Command: npx skills add https://github.com/ZanzyTHEbar/dragonarchy --skill technical-writing-zanzythebar

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Producing clear, accurate technical prose is hard: documentation often lacks structure, contains unsupported claims, or misses the audience's level. This Skill provides a disciplined workflow for planning, drafting, and reviewing technical writing so the output is factual, well-organized, and reader-appropriate. ## Core Features & Use Cases - Structured drafting workflow: Identify audience, goal, and prerequisites first, then build sections that progress from problem statement to concept definition, examples, and next steps. - Style and accuracy guidance: Enforces plain language, active verbs, verified technical details, and explicit statements of uncertainty instead of invented facts. - Review checklist: Checks factual accuracy, audience fit, logical flow, terminology consistency, and unsupported claims before finalizing. - Use Case: Ask it to write a getting-started guide for a new CLI tool in your repository; it will verify details against the repo files and produce a polished Markdown tutorial. ## Quick Start Ask the assistant to write a beginner-friendly tutorial explaining how to set up and use your project's main configuration file.

Frequently Asked Questions about technical-writing

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

FAQPage Schema
How do I write clear technical documentation for a project?

Start by identifying the audience, goal, and prerequisites, then structure the document from problem statement to concept definition, examples, and next steps. Verify every technical claim against repository files or reliable sources before publishing.

How to structure a technical tutorial for beginners?

Open with the problem or a concrete consequence, define prerequisites before introducing complexity, and use progressively richer examples. Close with a concise summary and practical next steps, keeping one idea per section.

What style rules improve technical writing quality?

Prefer plain language, active verbs, and concrete nouns, with natural sentence rhythm and sparing analogies. Tailor depth to the reader and avoid unsupported claims, invented metrics, or repetitive section templates.

Can this skill edit existing documentation without changing its meaning?

Yes, the editing guidance explicitly preserves the author's original meaning and forbids adding unsupported claims. It focuses on clarity, flow, terminology consistency, and factual accuracy during review.

What output formats does technical writing support?

Markdown is the default output format, including headings, lists, tables, code blocks, and Mermaid diagrams where they improve clarity. Other formats can be produced when the user explicitly requests them.