JPeetz/agent-skills / skills/documentation-content/documentation-and-adrs
documentation-and-adrs
VerifiedUse this skill when you need to record an architecture decision (ADR) or document the reasoning behind a design choice — when changing public APIs, shipping features that change behavior, or recording context that future engineers (human or agent) will need to understand the codebase. Does NOT replace code comments or inline docstrings; targets strategic documentation and decision capture. Primary keywords: ADR architecture decision record, technical documentation, design rationale, decision log, API documentation, README writing, changelog, documentation-driven development, inline documentation best practices, specification writing. For all major agentic platforms.
| File | Kind | Size |
|---|---|---|
| CHANGELOG.md | markdown | 941 B |
| LICENSE | other | 1.0 KB |
| SKILL.md | skill md | 12.0 KB |
| evals/evals.json | config | 5.9 KB |
| references/adr-template.md | markdown | 2.3 KB |
| references/api-docs-checklist.md | markdown | 2.0 KB |
| references/readme-template.md | markdown | 2.1 KB |
references/readme-template.md
View on GitHub# [Project Name]
> One-line description — what it does and why someone should care.
[Build Status] [Coverage] [Version] [License]
## Overview
2-3 sentences on what the project is and the problem it solves. Who is the
target audience? What makes this different from alternatives?
## Quick Start
The absolute minimum to get running. Copy-paste-able commands that work end
to end. If it takes more than 5 commands or 2 minutes, simplify.
```bash
# Example
npm install
npm start
# Open http://localhost:3000
```
## Installation
Detailed install instructions. Prerequisites first. Per-platform if needed.
### Prerequisites
- Node.js 18+
- PostgreSQL 15+
- Redis 7+ (optional, for caching)
### macOS / Linux
```bash
git clone https://github.com/owner/project.git
cd project
npm install
cp .env.example .env
# Edit .env with your database credentials
npm run db:migrate
npm run dev
```
### Windows
[Windows-specific instructions if different]
## Usage
Common use cases with code examples. Link to full API docs rather than
inlining them.
```javascript
import { Client } from 'project-sdk';
const client = new Client({ apiKey: process.env.API_KEY });
const result = await client.search({ query: 'example' });
console.log(result);
```
## Configuration
All config options with defaults, descriptions, and env var equivalents.
| Option | Default | Description | Env Var |
|--------|---------|-------------|---------|
| `port` | `3000` | HTTP server port | `PORT` |
| `database.url` | — | PostgreSQL connection string | `DATABASE_URL` |
| `redis.url` | — | Redis connection string (optional) | `REDIS_URL` |
## Architecture
High-level description of how components fit together. Link to ADRs for
significant decisions.
```mermaid
graph TD
A[Client] --> B[API Gateway]
B --> C[Service A]
B --> D[Service B]
C --> E[(Database)]
```
## Contributing
How to set up a dev environment, run tests, and submit changes.
```bash
npm test # Run test suite
npm run lint # Run linter
npm run build # Build for production
```
## License
[MIT](LICENSE) — see LICENSE file for details.Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation). | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK). | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |