technical-writer

Generate structured technical documentation from API references, READMEs, and user guides.

Updated Mar 5, 2026
One-click install
npx skills add https://github.com/ThanabordeeN/gemini-productivity-skills --skill technical-writer-thanabordeen
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/ThanabordeeN/gemini-productivity-skills/tree/main/technical-writer
Command: npx skills add https://github.com/ThanabordeeN/gemini-productivity-skills --skill technical-writer-thanabordeen

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The skill helps teams produce clear, consistent technical documentation—API references, READMEs, tutorials, and user guides—without compromising readability or structure.

Core Features & Use Cases

  • Clear, user-centered documentation that explains concepts and workflows.
  • Templates for READMEs, API references, architecture guides, and tutorials.
  • Scannable formatting with headings, code samples, and accessible terminology for developers and end users.
  • Use Case: When you need to produce a complete documentation package for a new API or product.

Quick Start

Provide a topic and I will generate clear, structured technical documentation.

Frequently Asked Questions about technical-writer

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

FAQPage Schema
How do I generate structured API documentation from API references automatically?

To generate API documentation, provide an API reference or topic to create clear, structured technical documentation. This process automates formatting with consistent voice, scannable headings, and runnable code examples.

What is the best way to write developer guides and onboarding materials?

Developer guides and onboarding materials are best written using templates that ensure user-centered clarity. This approach produces scannable formatting with accessible terminology for developers and end users.

Can I create a complete documentation package for a new product?

You can create a complete documentation package for a new product by generating README files, architecture guides, tutorials, and changelogs. This ensures consistent voice and user-friendly structure across all materials.

How do I ensure my README files and tutorials have scannable formatting?

README files and tutorials achieve scannable formatting by applying structured templates with headings, code samples, and accessible terminology. This ensures technical documentation remains clear and readable.

Does this technical writing approach work for both developers and end users?

This technical writing approach works for both developers and end users by focusing on user-centered clarity. It applies accessible terminology and scannable formatting to explain concepts and workflows effectively.

When do I need to generate architecture diagrams and changelogs for my API?

You need to generate architecture diagrams and changelogs when producing a complete documentation package for a new API. This ensures technical documentation covers all structural and versioning updates consistently.