skills.rest
sumik5
sumik5COMMUNITY
Explore all skills by this author →
𝕏@shivasek5GitHub

technical-writing

Generate technical reports following the 7 Cs principles.

2|2|Updated Feb 9, 2017
Search Tags:#quality assurance#reports#documentation#technical writing#communication#style guide#content creation
One-click install
npx skills add https://github.com/sumik5/dotfiles --skill technical-writing-sumik5
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writing
Source: https://github.com/sumik5/dotfiles/tree/main/claude-code/skills/technical-writing
Command: npx skills add https://github.com/sumik5/dotfiles --skill technical-writing-sumik5

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures all technical documentation, reports, and communications adhere to high-quality standards, following the "7 Cs" principles (Clear, Concise, Correct, Coherent, Concrete, Complete, Courteous). It eliminates ambiguity, redundancy, and factual errors, saving time in reviews and improving information transfer.

Core Features & Use Cases

  • 7 Cs Principle Application: Guides the creation of documentation to be clear, concise, correct, coherent, concrete, complete, and courteous.
  • Structured Document Generation: Provides templates and best practices for various technical documents, including reports, API specifications, and READMEs.
  • Anti-Pattern Avoidance: Identifies and helps correct common writing mistakes like jargon, passive voice, and ambiguous language.
  • Use Case: When writing a complex API specification, activate this Skill to ensure all endpoints are clearly defined, request/response examples are provided, and the language is consistent and accurate, reducing developer confusion.

Quick Start

Generate a technical report for the "User Authentication Feature" implementation, ensuring it follows the 7 Cs principles and includes a quality checklist.