Skip to content

aetox-skills/docstruct

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DocStruct

DocStruct is an installable documentation architecture skill for AI agents. It teaches agents how to create clear, non-duplicated, source-of-truth driven, token-efficient project documentation.

DocStruct documentation architecture

What Makes DocStruct Different?

DocStruct is not a Markdown template repo. It is an agent behavior package.

It tells agents how to decide:

  • when to update existing docs instead of creating new files
  • where each type of documentation belongs
  • how to avoid duplicated Markdown content
  • how to mark TODO and UNKNOWN information clearly
  • how to keep documentation small enough for repeated agent workflows

Quick Use

Choose the path that matches your agent:

  1. Generic AI Agent Copy SKILL.md into your agent instruction context.

  2. Cursor Copy adapters/cursor/docstruct.mdc into .cursor/rules/docstruct.mdc.

  3. AGENTS.md Copy adapters/agents-md/AGENTS.example.md into your project as AGENTS.md.

Use DocStruct With Your Agent

Use this prompt after adding the matching instruction file:

Use DocStruct to inspect this project, update existing docs before creating new files, keep one source of truth, and mark TODO or UNKNOWN items clearly.

For more setup options, see INSTALL.md.

Compatibility

DocStruct includes adapters for:

Core Rules

  • Read before writing.
  • Use the smallest useful document.
  • Update existing docs before creating new files.
  • Keep one source of truth.
  • Link instead of copying.
  • Mark TODO and UNKNOWN instead of inventing details.
  • Avoid decorative or placeholder documentation.

Repository Structure

.
|-- SKILL.md
|-- INSTALL.md
|-- README.md
|-- CHANGELOG.md
|-- references/
|-- adapters/
|-- prompts/
|-- templates/
|-- skill/
|-- examples/
`-- assets/

License

MIT. See LICENSE.