document

Update TSDoc headers and AGENTS.md files for changed Git files and directories.

14|Updated Jun 4, 2026
One-click install
npx skills add https://github.com/Cogni-DAO/node-template --skill document-cogni-dao
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document
Source: https://github.com/Cogni-DAO/node-template/tree/main/.openclaw/skills/document
Command: npx skills add https://github.com/Cogni-DAO/node-template --skill document-cogni-dao

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pnpm, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill streamlines documentation updates by automatically modifying file headers and the AGENTS.md file, ensuring consistency and accuracy across your project's documentation.

Core Features & Use Cases

  • Automated Header Updates: Updates TSDoc headers for changed files based on predefined templates.
  • Directory Documentation: Manages AGENTS.md files for subdirectories, reflecting changes in exports, routes, or ownership.
  • Use Case: After refactoring a module, use this Skill to ensure all affected file headers are updated with the new behavior and that the AGENTS.md file accurately reflects the module's public interface.

Quick Start

Run the document skill to update documentation for changed files and directories.

Frequently Asked Questions about document

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

FAQPage Schema
How do I automate documentation updates for changed files in a Git repository?

To automate documentation updates for changed files in a Git repository, use this Skill to modify top-of-file TSDoc headers and AGENTS.md files according to predefined templates, ensuring documentation aligns with code changes and directory structure.

What is the best way to update file headers after refactoring a module?

The best way to update file headers after refactoring a module is running an automated documentation update that modifies TSDoc headers for changed files based on predefined templates, ensuring all affected headers reflect the new behavior.

How does directory documentation management work for AGENTS.md files?

Directory documentation management for AGENTS.md files works by automatically modifying the files in subdirectories to reflect changes in exports, routes, or ownership, ensuring the directory structure aligns with the code.

Do I need pnpm installed to update TSDoc headers and AGENTS.md files?

Yes, you need pnpm installed to update TSDoc headers and AGENTS.md files, as pnpm is a required dependency for executing the scripts and references components that perform the documentation updates.

Can I use this automation to ensure documentation aligns with code changes during agile development?

Yes, you can use this automation to ensure documentation aligns with code changes during agile development by automatically updating TSDoc headers and AGENTS.md files for changed files, maintaining consistency across project iterations.