role-technical-writer

Generate structured templates and clarity principles for technical documentation.

2|Updated Apr 10, 2024
One-click install
npx skills add https://github.com/gdurandvadas/dotfiles --skill role-technical-writer
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: role-technical-writer
Source: https://github.com/gdurandvadas/dotfiles/tree/main/config/opencode/skills/role-technical-writer
Command: npx skills add https://github.com/gdurandvadas/dotfiles --skill role-technical-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provides structured guidance for producing clear, audience-appropriate technical documentation by delivering templates, writing patterns, and standards.

Core Features & Use Cases

  • Documentation structure templates for user guides, API references, and reviews.
  • Audience-focused writing patterns to improve clarity, tone, and readability.
  • Documentation standards and best practices to ensure consistency across projects.
  • Use Case: Generate public API docs that are approachable for developers and non-technical stakeholders.

Quick Start

Provide your first draft using the templates and apply the clarity principles to produce a polished document.

Frequently Asked Questions about role-technical-writer

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

FAQPage Schema
What is the best way to structure technical documentation for multiple audiences?▼

Templates for technical writing provide pre-built structures for user guides, API references, and reviews, ensuring consistency and approachability across software projects by applying audience-focused writing patterns.

How do I write public API docs that are approachable for non-technical stakeholders?▼

To write public API docs that are approachable for non-technical stakeholders, apply audience-focused writing patterns and clarity principles to structured templates, ensuring the technical content remains readable and accessible to non-technical stakeholders.

Can I use these templates for software project standards documentation?▼

Yes, you can use these templates for software project standards documentation. The skill provides writing patterns and documentation standards designed to ensure consistency across user-facing docs, public APIs, and technical reviews.

How do I apply clarity principles to a rough draft of user-facing documentation?▼

To apply clarity principles to a rough draft, provide your first draft to the templates and apply the structured writing patterns and standards to produce a polished, audience-appropriate document.

What documentation standards are recommended for maintaining consistency across projects?▼

Recommended documentation standards for maintaining consistency include using a frontmatter-driven metadata schema with standardized sections, roles, and focus, alongside structured templates and clarity principles for technical content.

When should I not use structured templates for technical writing?▼

You should avoid structured templates for technical writing when your content does not fit standard user guides, API references, or technical reviews, or when strict frontmatter-driven schemas hinder readability and audience clarity.