# Juandelossantos Another Agent Skills Documentation And Adrs

> Documentation and ADRs

- Skill: `tomevault-io/juandelossantos-another-agent-skills-documentation-and-adrs` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add tomevault-io/juandelossantos-another-agent-skills-documentation-and-adrs`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/juandelossantos-another-agent-skills-documentation-and-adrs/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: AI & ML
- Author: tomevault-io (https://skillmd.com/u/tomevault-io)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/tomevault-io/juandelossantos-another-agent-skills-documentation-and-adrs

---


# Documentation and ADRs

Document decisions, not just code. The most valuable documentation captures the *why*.

## When to Use

- Making a significant architectural decision
- Choosing between competing approaches
- Adding or changing a public API
- Shipping a feature that changes user-facing behavior
- Onboarding new team members or agents

**When NOT to use:** Don't document obvious code or throwaway prototypes.

## Core Workflows

### Architecture Decision Records
→ See `guides/ADR-GUIDE.md`

ADR template, lifecycle, when to write them.

### Inline Documentation
→ See `guides/INLINE-DOCS.md`

Comment the *why*, not the *what*.

### README Structure
→ See `guides/README.md`

Quick start, commands, architecture overview.

## Detailed Guides

| Guide | Content |
|-------|---------|
| `guides/ADR-GUIDE.md` | ADR template, lifecycle, when to write |
| `guides/INLINE-DOCS.md` | Comment principles, gotchas, API docs |
| `guides/README.md` | README template, changelog format |

## Quick Reference

```
ADR status: PROPOSED → ACCEPTED → (SUPERSEDED or DEPRECATED)

Comment the *why*, not the *what*.
Don't leave commented-out code.
```

## Red Flags

- Architectural decisions with no written rationale
- Public APIs with no documentation
- README that doesn't explain how to run
- Commented-out code instead of deletion
- No ADRs in a project with significant architectural choices

---
> Source: [juandelossantos/another-agent-skills](https://github.com/juandelossantos/another-agent-skills) — distributed by [TomeVault](https://tomevault.io).
<!-- tomevault:4.0:skill_md:2026-06-15 -->

