Getting it into your agent
One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.
npx agentmods add agents/atebites-hub/pjtemplate/documentation_guidelines_templategit clone --depth 1 https://github.com/atebites-hub/PJTemplateWhat it costs to keep this loaded
Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5 | $0.00000 | $0.01297 |
| Opus 5 | $0.00000 | $0.00648 |
| Sonnet 5 | $0.00000 | $0.00259 |
| Haiku 4.5 | $0.00000 | $0.00130 |
Grade A, and why
documentation_guidelines_template scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.
A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.
Nothing flagged
None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.
How it starts
The opening of the file, as written. The whole thing — 170 lines — stays where its author put it; the contents beside it link to each section on GitHub.
Documentation Guidelines Template
This document defines documentation practices for [Project Name], ensuring maintainability, onboarding speed, and reliable agent comprehension. Documentation is a living artifact and must evolve with code.
Guidelines for Filling Out This Template
- Replace [Project Name] with your project's name.
- Choose doc tools that integrate with your stack ([tool: JSDoc/Sphinx/rustdoc/Typedoc]).
- Configure automated documentation checks where possible.
- Define clear ownership for comments, docstrings, architecture docs, and test docs.
- Keep this document as the source of truth for comments/docstrings/doc updates.
- Reference repo structure: Store this in
/docs/agents/documentation_guidelines.md.
Document Ownership and Overlap Rules
To avoid duplicate standards across core docs:
- This document owns:
- Inline comments and docstring standards
/docs/code/,/docs/tests/,/docs/api/update requirements- Documentation quality gates and review workflow
coding_standards.mdowns code behavior standards (naming, control flow, errors, security, concurrency).testing_guidelines.mdowns test architecture and test execution policy.AGENTS.mdowns project-level gates and process requirements.
If standards overlap, keep normative detail here and reference from other docs.
Documentation Structure
- /docs/agents/: Context boundary documents (AI and human process docs)
- Files:
project_requirements_doc.md,app_flow_doc.md,tech_stack_doc.md,client_guidelines.md,server_structure_doc.md,implementation_plan.md,file_structure_doc.md,testing_guidelines.md,coding_standards.md, this file.
- Files:
- /docs/code/: Per-module technical documentation
- Include architecture diagrams, module responsibilities, contracts, and examples.
- /docs/tests/: Test documentation and quality notes
- Include strategy, execution commands, fixtures, and known flake risks.
- /docs/api/: API contracts and integration notes
- OpenAPI/Swagger specs, endpoint docs, versioning/deprecation notes.
What this file has done since we first saw it
Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.
- 2d ago First seen · 170 lines · 0 tokens per session scan A edd804e57959
documentation_guidelines_template is an agent published in the GitHub repository atebites-hub/PJTemplate (2 stars, last pushed 9d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 1,297 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.
Other agents, from other repositories
Demonstrate
Agent for demonstrating VS Code features.
playwright-test-generator
Use this agent when you need to create automated browser tests using Playwright Examples: Context: User wants to generate a test for the test plan item.
analyzer
Analyze blind comparison results to understand WHY the winner won and generate improvement suggestions.
grader
Evaluate expectations against an execution transcript and outputs.
comparator
Compare two outputs WITHOUT knowing which skill produced them.
.NET-Notebook-Migration-Agent
Expert .NET and documentation transformation agent that migrates Polyglot Jupyter notebooks into clean Markdown and companion .NET sample code.