documentation-writer

Content & Writing

Gives your agent the ability to create expert-level technical documentation structured according to the Diátaxis framework's four quadrants.

When to use

When you need to create a tutorial for onboarding new users
When you need a precise technical reference for an API or machinery
When you want to explain complex concepts or architectural decisions

How to use

1
Specify the document type: Tutorial, How-to, Reference, or Explanation
2
Define the target audience and the specific goal they want to achieve
3
Review the proposed document structure and outline for approval
4
Provide project context or existing markdown files for style alignment

Example conversation

case

You

I need a how-to guide for our new CLI tool that shows users how to authenticate and run their first scan.

Agent

I'll create a problem-oriented How-to Guide following the Diátaxis framework. First, let's clarify the exact steps for authentication and the scan command. I'll then propose a recipe-style structure that focuses on the practical steps needed for a successful first scan, ensuring the language is simple and clear.

FAQ

Related Skills

api-documentationDeveloper Tools

Gives your agent the ability to create comprehensive, interactive, and developer-friendly API documentation using OpenAPI and Swagger standards.

create-oo-component-documentationDeveloper Tools

Gives your agent the ability to generate comprehensive, standardized technical documentation for object-oriented components, complete with architecture diagrams and API references.

update-oo-component-documentationContent & Writing

Gives your agent the ability to update object-oriented component documentation by analyzing source code and implementation patterns.

tdd-test-writerDeveloper Tools

Gives your agent the ability to write failing tests first, creating a strict behavior contract for test-driven development.

agentationDeveloper Tools

Gives your agent the ability to add a visual feedback and annotation toolbar to Next.js projects for real-time syncing between users and AI agents.

documentation-writer

Content & Writing

Gives your agent the ability to create expert-level technical documentation structured according to the Diátaxis framework's four quadrants.

When to use

When you need to create a tutorial for onboarding new users
When you need a precise technical reference for an API or machinery
When you want to explain complex concepts or architectural decisions

How to use

1
Specify the document type: Tutorial, How-to, Reference, or Explanation
2
Define the target audience and the specific goal they want to achieve
3
Review the proposed document structure and outline for approval
4
Provide project context or existing markdown files for style alignment

Example conversation

case

You

I need a how-to guide for our new CLI tool that shows users how to authenticate and run their first scan.

Agent

FAQ

Related Skills

api-documentationDeveloper Tools

Gives your agent the ability to create comprehensive, interactive, and developer-friendly API documentation using OpenAPI and Swagger standards.

create-oo-component-documentationDeveloper Tools

Gives your agent the ability to generate comprehensive, standardized technical documentation for object-oriented components, complete with architecture diagrams and API references.

update-oo-component-documentationContent & Writing

Gives your agent the ability to update object-oriented component documentation by analyzing source code and implementation patterns.

tdd-test-writerDeveloper Tools

Gives your agent the ability to write failing tests first, creating a strict behavior contract for test-driven development.

agentationDeveloper Tools

Gives your agent the ability to add a visual feedback and annotation toolbar to Next.js projects for real-time syncing between users and AI agents.

Product

Community

documentation-writer

When to use

How to use

Example conversation

FAQ

Related Skills

Product

Community

documentation-writer

When to use

How to use

Example conversation

FAQ

Related Skills

Product

Community