tech-writing

Draft, rewrite, and structure technical content with YAML frontmatter and evidence-first reasoning.

Updated Jun 4, 2026
One-click install
npx skills add https://github.com/mostafa-K-raihan/skills --skill tech-writing-mostafa-k-raihan
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: tech-writing
Source: https://github.com/mostafa-K-raihan/skills/tree/main/tech-writing
Command: npx skills add https://github.com/mostafa-K-raihan/skills --skill tech-writing-mostafa-k-raihan

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Draft, rewrite, review, and structure technical content so it is clear, concise, reader-first, accessible, evidence-backed, and action-oriented.

Core Features & Use Cases

  • Draft, rewrite, and review technical content to ensure clarity, consistent terminology, and accessible presentation.
  • Structure documents such as README files, design docs, API references, tutorials, onboarding guides, release notes, specs, comments, CLI help, and support content; and guide Chinese technical prose toward evidence-first reasoning when needed.
  • Load and apply workflow guidelines, including an overview, rewrite heuristics, and a review checklist, using references/chinese-technical-prose.md for language style when appropriate.

Quick Start

Draft a clear technical document outline using tech-writing guidelines.

Frequently Asked Questions about tech-writing

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

FAQPage Schema
How do I write a README that is clear and accessible for developers?

To write a clear README, draft and structure your technical content using a reader-first approach that enforces evidence-first reasoning, consistent terminology, and accessible presentation throughout the document.

What is the best way to structure API documentation for readability?

The best way to structure API documentation is by applying a structured drafting and reviewing workflow that enforces YAML frontmatter usage and evidence-first reasoning to ensure clarity and consistent terminology.

How do I rewrite technical content to improve clarity and reader focus?

Rewrite technical content to improve clarity by applying structured heuristics and a review checklist that enforce concise, evidence-backed, and action-oriented prose for your readers.

Can I use this workflow for drafting tutorials and onboarding guides?

Yes, you can use this workflow for drafting tutorials and onboarding guides, as it applies to documentation, design docs, release notes, specs, comments, CLI help, and support content.

Does this technical writing approach support Chinese technical prose?

Yes, it supports Chinese technical prose by loading and applying specific language style guidelines from internal references to guide your content toward evidence-first reasoning when needed.

Why does my technical documentation lack consistent terminology?

Your documentation lacks consistent terminology because it needs a structured review process that enforces reader-first drafting, evidence-first reasoning, and clear accessible presentation guidelines.