documentation-writer

Generate Diátaxis-aligned documentation with Tutorials, How-tos, References, and Explanations.

Updated Mar 16, 2026
One-click install
npx skills add https://github.com/Sanali209/BCor --skill documentation-writer-sanali209
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-writer
Source: https://github.com/Sanali209/BCor/tree/main/.agents/skills/documentation-writer
Command: npx skills add https://github.com/Sanali209/BCor --skill documentation-writer-sanali209

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Teams often struggle to produce consistent, audience-appropriate software documentation across Tutorials, How-tos, References, and Explanations. This Skill provides a structured Diátaxis-based workflow to generate, organize, and maintain high-quality docs with clear intent and tone.

Core Features & Use Cases

  • Diátaxis-aligned documentation across the four quadrants (Tutorials, How-to Guides, Reference, Explanation) for any software project.
  • Guided prompts and templates to ensure consistent tone, terminology, and structure, reducing maintenance time.
  • Use cases include onboarding developers, supporting user adoption, and documenting APIs or workflows with clear, task-oriented guidance.

Quick Start

Tell me the topic, audience, and goals, and I will generate a complete Diátaxis-aligned documentation set.

Frequently Asked Questions about documentation-writer

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

FAQPage Schema
How do I create technical documentation using the Diátaxis framework?

The Diátaxis framework structures technical documentation across four quadrants: Tutorials, How-to guides, References, and Explanations. This Skill generates content aligned to each quadrant, ensuring audience-specific guidance with consistent tone and Markdown-ready outputs.

What is the best way to structure software documentation for different audiences?

The best way to structure software documentation is separating content by intent. This Skill uses the Diátaxis method to distinguish learning-oriented Tutorials from task-oriented How-tos, information-oriented References, and understanding-focused Explanations.

Can I generate API documentation and user guides in Markdown format?

Yes, you can generate API documentation and user guides in Markdown format. This Skill produces Markdown-ready outputs across all Diátaxis quadrants, supporting onboarding, API references, and user guides requiring structured, audience-specific content.

Does the Diátaxis documentation method work for developer onboarding?

Yes, the Diátaxis documentation method works effectively for developer onboarding. This Skill creates learning-oriented Tutorials and task-oriented How-tos that guide new developers through software workflows with clear, step-by-step, audience-specific instructions.

How do I maintain consistent tone and terminology across user guides?

You maintain consistent tone and terminology across user guides by using guided prompts and templates. This Skill enforces Diátaxis structure and consistency, reducing maintenance time while ensuring clear intent across all generated documentation.

When should I not use template-based documentation generation?

You should not use template-based documentation generation when content requires highly unstructured, narrative formats outside the Diátaxis quadrants. This Skill enforces strict separation into Tutorials, How-tos, References, and Explanations, which may not suit free-form documentation needs.