skills.rest
rahulgupta2018
rahulgupta2018COMMUNITY
Explore all skills by this author →
GitHub

technical-writer

Generate developer and user documentation with structured templates and runnable code examples.

Updated Jul 23, 2026
Search Tags:#documentation#technical writing#developer experience#readme#tutorial#api reference
One-click install
npx skills add https://github.com/rahulgupta2018/agent-skills --skill technical-writer-rahulgupta2018
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/rahulgupta2018/agent-skills/tree/main/skills/technical-writer
Command: npx skills add https://github.com/rahulgupta2018/agent-skills --skill technical-writer-rahulgupta2018

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill eliminates the friction of creating high-quality technical documentation by providing structured templates and principles that prioritize reader goals over feature lists.

Core Features & Use Cases

  • Structured Templates: Standardized formats for READMEs, API references, and tutorials to ensure consistency.
  • Progressive Disclosure: Techniques to structure content from quick-start summaries to deep-dive technical details.
  • Use Case: Use this skill to transform a raw list of API endpoints into a professional, scannable API reference guide that includes runnable examples and troubleshooting steps.

Quick Start

Use the technical-writer skill to draft a README for the current project that includes a quick start section and a troubleshooting guide.

Frequently Asked Questions about technical-writer

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

FAQPage Schema
How do I write a professional README that prioritizes reader goals over feature lists?▼

To write a professional README, use structured templates that prioritize reader goals over feature lists. This approach structures content for progressive disclosure, moving from quick-start summaries to deeper technical details to ensure reader-centric clarity.

What is the best way to transform raw API endpoints into a scannable API reference guide?▼

Transforming raw API endpoints into an API reference guide requires structuring technical content for progressive disclosure. You standardize the format with predefined templates and include verified, runnable code examples alongside troubleshooting steps.

How does progressive disclosure work when structuring technical documentation?▼

Progressive disclosure in technical documentation works by structuring content from quick-start summaries to deep-dive technical details. This technique ensures reader-centric clarity by progressively revealing complex information only when the user needs it.

Can I use predefined templates to generate developer tutorials with runnable code examples?▼

Yes, you can use predefined templates to generate developer tutorials with runnable code examples. The process requires adherence to these standardized formats to ensure consistency and reader-centric clarity across your documentation.

Do I need verified code examples to include troubleshooting steps in my API reference?▼

Yes, you need verified, runnable code examples to include troubleshooting steps in an API reference. The documentation process requires these verified examples to ensure the troubleshooting guidance remains accurate and actionable for developers.

Related Skills

Explore More Content & Communication Skills→
robbytrobbyt
42

view-file

Fetch raw file content from GitHub blob and tree URLs.

Community
Intermediate
vasilyu1983vasilyu1983
73

docs-codebase

Generate documentation templates for READMEs, ADRs, API docs, and changelogs.

Community
Intermediate
carayacaraya
1

code-example-validation

Validate code examples in documentation for correctness and safety.

Community
Intermediate
dimsourdimsour
2

dotnet:document

Generate XML documentation, READMEs, and OpenAPI descriptions from .NET source code.

Community
Intermediate