skills.rest
GainInsightDev
GainInsightDevOFFICIAL
Explore all skills by this author →
WebsiteGitHub

af-write-documentation

Write and structure documentation files with YAML frontmatter and bidirectional links.

Updated Feb 8, 2026
Search Tags:#documentation#writing#markdown#api#standards#agentflow
One-click install
npx skills add https://github.com/GainInsightDev/websites --skill af-write-documentation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: af-write-documentation
Source: https://github.com/GainInsightDev/websites/tree/main/.claude/skills/af-write-documentation
Command: npx skills add https://github.com/GainInsightDev/websites --skill af-write-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps users create and update documentation according to AgentFlow's specific standards, ensuring consistency and discoverability across the project.

Core Features & Use Cases

  • New Documentation Creation: Guides users through writing new documentation files, including feature and API documentation.
  • Documentation Updates: Assists in modifying existing documentation to maintain accuracy and relevance.
  • Standard Enforcement: Ensures adherence to AgentFlow's frontmatter, linking, and content guidelines.
  • Use Case: A developer needs to document a new API endpoint. They use this skill to create a new SKILL.md file, ensuring it has the correct YAML frontmatter, relevant tags, and links to related documentation.

Quick Start

Use the af-write-documentation skill to create a new documentation file for the user authentication feature.

Frequently Asked Questions about af-write-documentation

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

FAQPage Schema
How do I write API documentation with proper YAML frontmatter and bidirectional linking?▼

To write API documentation with YAML frontmatter and bidirectional linking, follow established standards for content structure and metadata. This ensures new documentation files remain discoverable and maintainable across the project.

What's the best way to structure markdown files for new software features?▼

The best way to structure markdown files for new features is to enforce consistent content guidelines and metadata standards. This approach facilitates clear feature explanations and proper integration with existing documentation.

How do I update existing markdown documentation to meet current project standards?▼

Updating existing markdown documentation to current standards involves modifying files to adhere to specific frontmatter and linking rules. This maintains accuracy and relevance while ensuring discoverability.

When do I need to use YAML frontmatter in documentation files?▼

You need to use YAML frontmatter in documentation files when a project requires standardized metadata for discoverability and content guidelines. It establishes essential structure for new feature explanations and API references.

Does this documentation approach work for creating both API references and feature explanations?▼

Yes, this documentation approach works for creating both API references and feature explanations. It guides users through writing new documentation files while enforcing necessary standards and bidirectional linking across both content types.

Why does documentation need bidirectional linking and content guidelines?▼

Documentation needs bidirectional linking and content guidelines to ensure maintainability and discoverability across the project. Adhering to these standards guarantees that new documentation integrates properly with existing references.

Related Skills

Explore More Software Engineering Skills→
luebkenluebken

validate-md

Validate Markdown YAML frontmatter against JSON Schema definitions.

Community
Intermediate
marinkobabicmarinkobabic

aif-docs

Generate README and topic-based markdown documentation from codebase analysis.

Community
Advanced
louloulinlouloulin
19

skill-md-validator

Validate SKILL.md files for YAML frontmatter, required fields, and content.

Community
Basic
peopleforresterpeopleforrester
3

api-docs

...

Community
Intermediate