af-writing-docs

Write documentation with frontmatter and bidirectional linking per AgentFlow standards.

Updated Feb 8, 2026
One-click install
npx skills add https://github.com/GainInsightDev/websites --skill af-writing-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: af-writing-docs
Source: https://github.com/GainInsightDev/websites/tree/main/.claude/skills/af-writing-docs
Command: npx skills add https://github.com/GainInsightDev/websites --skill af-writing-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures that all documentation adheres to AgentFlow's rigorous standards, including proper frontmatter, bidirectional linking, and a consistent structure, making documentation discoverable and maintainable.

Core Features & Use Cases

  • New Documentation Creation: Generates documentation for new features with correct formatting and metadata.
  • API/Feature Documentation: Documents existing features and APIs according to established standards.
  • Documentation Updates: Updates existing documentation to maintain consistency and accuracy.
  • Use Case: When a new feature is developed, use this skill to create its initial documentation, ensuring it's immediately compliant with AgentFlow's documentation system.

Quick Start

Use the af-writing-docs skill to create documentation for the new user authentication module.

Frequently Asked Questions about af-writing-docs

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

FAQPage Schema
How do I write technical documentation that follows proper standards and structure?

Technical documentation standards require correct frontmatter, bidirectional linking, and consistent structure to ensure files are discoverable and maintainable across your system.

What is the best way to create API documentation with consistent formatting and metadata?

API documentation generation applies established content rules and metadata formatting to new feature files, ensuring immediate compliance with documentation architecture and standards.

How do I update existing documentation to maintain consistency and accuracy?

Updating existing documentation involves applying standardized rules to maintain consistency, accuracy, and proper bidirectional linking within your established content architecture.

Does this documentation approach work for creating new files and documenting features?

Yes, the documentation approach applies to creating new files, documenting features or APIs, and updating existing documentation while satisfying discoverability and maintainability requirements.

Why does documentation need frontmatter and bidirectional linking?

Frontmatter and bidirectional linking are required to make documentation discoverable and maintainable, ensuring all files adhere to rigorous documentation architecture standards.

What are the limitations of using standardized documentation for content creation?

Standardized documentation is limited to files requiring frontmatter, bidirectional linking, and specific structural rules, making it unsuitable for freeform content outside established architecture.