tanaab-documentation

Define repository documentation standards with YAML frontmatter and Markdown guidance.

Updated Mar 6, 2026

Search Tags:#templates #documentation #markdown #governance #api-documentation #docs-site #readme-standards

Ready to run

npx skills add https://github.com/pirog/me --skill tanaab-documentation

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: tanaab-documentation
Source: https://github.com/pirog/me/tree/main/skills/tanaab-documentation
Command: npx skills add https://github.com/pirog/me --skill tanaab-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve?

Guides teams on repository documentation strategy, README structure, inline code and API documentation standards, and the escalation path to fuller documentation under the Tanaab coding structure.

Core Features & Use Cases

Establish README structure conventions, inline code guidelines, and API documentation policies.
Decide when to use a full README, a docs wrapper, or a dedicated docs site, and map content to different user journeys.
Use case: align onboarding, contributor guidance, and durable reference surfaces across multiple repositories.

Quick Start

Run the tanaab-documentation skill to outline repository documentation standards and mapping to the project’s docs strategy.

Frequently Asked Questions about tanaab-documentation

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

FAQPage Schema

What is the best way to structure repository documentation for different project types?▼

Repository documentation standards depend on project type to determine whether to use a full README, a docs wrapper, or a dedicated documentation site. This approach maps content to different user journeys, aligning onboarding, contributor guidance, and durable reference surfaces across multiple repositories.

How do I establish README structure conventions and API documentation policies?▼

You establish README structure conventions and API documentation policies by applying durable repository documentation standards. This process defines inline code guidelines and API documentation policies, creating an escalation path to fuller documentation under the Tanaab coding structure.

When do I need a dedicated docs site versus a standard README?▼

A dedicated docs site is needed when project complexity exceeds standard README capacity. You decide whether to use a full README, a docs wrapper, or a dedicated docs site by applying documentation strategy standards that map content to specific user journeys and contributor guidance.

Does this documentation governance approach require specific frontmatter formats?▼

Yes, the documentation governance approach requires a YAML frontmatter containing name and description fields. It also requires a Markdown body with actionable instructions to satisfy frontmatter-based discovery and structured documentation guidance across repository documentation.

How do I align onboarding and contributor guidance across multiple repositories?▼

You align onboarding and contributor guidance across multiple repositories by enforcing durable documentation standards. This strategy establishes consistent README structures, inline code guidelines, and API documentation policies, ensuring durable reference surfaces are mapped correctly for all project types.

What are the limitations of using markdown templates for API documentation?▼

Markdown templates for API documentation are limited when project complexity requires a full documentation site. The documentation strategy defines an escalation path, guiding teams on when to transition from standard READMEs or docs wrappers to dedicated documentation sites for comprehensive API guidance.