documentation-templates — independently scanned and version-tracked by SaferSkills.
SaferSkills independently audited documentation-templates (Agent Skill) and scored it 100/100 (green). The audit ran 55 deterministic rules across Security, Supply Chain, Maintenance, Transparency, and Community; it found 0 high-severity and 0 lower-severity findings. The full rule-by-rule trace and per-finding evidence are below. Free, methodology-open.
Findings & checks · 0 flagged
Every scanned point with the score it earned and what moved between them.
First recorded scan — no prior version to compare against.
The primary manifest — the file an agent reads to learn what this artifact does.
The layouts below are scaffolds. Drop in your project's specifics and prune whatever doesn't apply — a template that survives untouched usually means it wasn't read.
A reader scanning a new repo asks a predictable sequence of questions. Order the sections to answer them in that order:
| Section | The question it answers |
|---|---|
| Name + tagline | What even is this? |
| Quick start | How do I run it in five minutes? |
| Features | What can it actually do? |
| Configuration | How do I tune it? |
| API reference | Where are the details? |
| Contributing | How do I pitch in? |
| License | What am I allowed to do? |
# ProjectName
One sentence on what it does.
## Quick Start
[The fewest steps to a running instance]
## Features
- Does X
- Does Y
## Configuration
| Variable | Meaning | Default |
|----------|---------|---------|
| PORT | Listen port | 8080 |
## Docs
- [API reference](./docs/api.md)
- [Architecture](./docs/architecture.md)
## License
Apache-2.0## GET /orders/:id
Fetch a single order.
**Path params**
| Name | Type | Required | Meaning |
|------|------|----------|---------|
| id | string | yes | Order identifier |
**Responses**
- 200 — the order object
- 404 — no order with that id
**Example**
[A real request and its response]/**
* One line on what this does.
*
* @param amount - The charge in cents
* @returns The created receipt
* @throws PaymentError - if the card is declined
*
* @example
* const receipt = charge(1999);
*/| Worth a comment | Skip it |
|---|---|
| The reason behind a rule | Restating the code |
| A tricky algorithm | Line-by-line narration |
| Surprising behavior | Code that reads plainly |
| The contract a caller relies on | Internal mechanics |
Following the Keep a Changelog convention:
# Changelog
## [Unreleased]
### Added
- A new export endpoint
## [2.1.0] - 2026-03-15
### Added
- CSV import
### Changed
- Bumped the parser library
### Fixed
- Off-by-one in pagination# ADR-007: [short title]
## Status
Proposed · Accepted · Superseded
## Context
What forces are pushing us to decide?
## Decision
What did we choose?
## Consequences
What do we gain, and what do we give up?A compact map that crawlers and agents can read fast:
# ProjectName
> The one-sentence goal.
## Core files
- [src/main.ts]: entry point
- [src/routes/]: HTTP handlers
- [docs/]: long-form docs
## Concepts
- Tenant: a billing boundary
- Job: one unit of background workWhen the docs will be chunked and indexed, structure helps the index:
| Quality | Why it pays off |
|---|---|
| Scannable | Headings, lists, and tables let readers jump |
| Example-led | A snippet beats a paragraph of description |
| Layered | Easy path first, deep detail after |
| Current | A stale doc misleads worse than no doc |
Treat every template here as a first draft. The project's real needs decide what stays.
~30 seconds. Free. No account. Every finding cites a rule and a line of evidence.