technical-writer

Generate Diátaxis-compliant Markdown documentation drafts from user-provided topics.

1|Updated Apr 22, 2026
One-click install
npx skills add https://github.com/unrealandychan/AgentFoundry --skill technical-writer-unrealandychan
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: technical-writer
Source: https://github.com/unrealandychan/AgentFoundry/tree/main/skills/technical-writer
Command: npx skills add https://github.com/unrealandychan/AgentFoundry --skill technical-writer-unrealandychan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Clear, consistent documentation is hard to produce at scale; teams struggle to apply Diátaxis structure across tutorials, how-tos, references, and explanations.

Core Features & Use Cases

  • Enforces the Diátaxis framework across all documentation types (tutorials, how-tos, references, explanations).
  • Produces structured Markdown with appropriate frontmatter and context for activation.
  • Use Case: technical writers creating API docs or internal tooling guides that must be publish-ready with minimal rework.

Quick Start

Provide a topic and target Diátaxis type to generate a ready-to-edit documentation draft.

Frequently Asked Questions about technical-writer

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

FAQPage Schema
How do I generate Diataxis documentation from existing markdown content?

To generate Diataxis documentation, provide your existing markdown content and specify the target documentation type. The system applies the Diataxis framework to produce structured, publication-ready drafts with frontmatter and runnable examples.

What is the best way to structure technical tutorials and how-to guides consistently?

The best way to structure technical tutorials and how-to guides consistently is to apply the Diataxis framework. This separates tutorials, how-tos, references, and explanations into distinct categories with enforced section structures and metadata.

Can I use this to create API references and developer guides that are ready to publish?

Yes, you can create publication-ready API references and developer guides. The system enforces frontmatter-driven metadata and runnable examples to ensure the output requires minimal rework before publishing.

Does this approach work for product documentation workflows as well as developer docs?

Yes, this approach works for both product documentation workflows and developer documentation. It applies the Diataxis structure across all content types, ensuring clear, consistent educational and explanatory material regardless of the target audience.

What do I need to provide to start drafting technical documentation with this method?

To start drafting technical documentation, you need to provide a specific topic and the target Diataxis type. The system then generates a ready-to-edit draft complete with the appropriate frontmatter and structural sections.