Global Documentation

Enforce global documentation standards across codebases from central standards files.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/jaypaulb/CanvusAPI-LLMDemo --skill global-documentation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Global Documentation
Source: https://github.com/jaypaulb/CanvusAPI-LLMDemo/tree/main/.claude/skills/global-documentation
Command: npx skills add https://github.com/jaypaulb/CanvusAPI-LLMDemo --skill global-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Lack of up-to-date and consistent documentation hinders onboarding, slows down maintenance, and creates knowledge silos. This Skill guides the AI to generate comprehensive and standardized documentation, ensuring all aspects of your project are well-documented.

Core Features & Use Cases

  • Automated API Docs: Instructs AI on generating clear and detailed API documentation.
  • Code Comment Generation: Guides AI to create meaningful comments and docstrings for code.
  • Use Case: After developing a new service, use this Skill to have the AI automatically generate its API documentation, including endpoint descriptions, request/response examples, and authentication details.

Quick Start

Generate API documentation for the UserService class in user_service.java, including endpoints, parameters, and responses.

Frequently Asked Questions about Global Documentation

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

FAQPage Schema
How do I generate consistent API documentation across my codebase?

API documentation generation enforces standardized formatting and structure across all endpoints. This Skill applies global documentation standards to create consistent API docs with endpoint descriptions, request/response examples, and authentication details automatically, ensuring uniform presentation across your entire codebase.

What's the best way to add meaningful code comments and docstrings automatically?

Automated code comment generation creates contextually appropriate docstrings and comments aligned with your project's documentation standards. The Skill guides AI to generate meaningful comments for functions, classes, and modules, maintaining consistency in style and detail level across all files.

How can I ensure documentation stays up to date across multiple files?

Repository-wide documentation audits enforce compliance with central documentation standards across your entire codebase. This Skill reads global standards and applies formatting, linking, and propagation rules to keep documentation synchronized, reducing knowledge silos and maintenance overhead.

Can I use this for cross-file documentation linking?

Yes, the Skill implements cross-file linking rules specified in global documentation standards. It ensures references between files remain consistent and valid, automating link propagation so documentation changes update correctly throughout your repository.

What documentation standards does this enforce?

This Skill enforces standards defined in agent-os/standards/global/documentation.md, covering formatting conventions, linking patterns, and compliance requirements. It applies these standards to all files containing global documentation references, ensuring coding-standard compliance and consistent documentation generation.

Does this help with user guide and technical documentation generation?

Yes, the Skill guides AI to generate comprehensive user guides and technical documentation with standardized structure and formatting. It ensures all documentation aspects—from API specs to usage guides—follow consistent patterns and remain synchronized across your project.