# Build Definitive Technical Documentation

Complex codebases hide architecture and design rationale. This skill turns repository evidence into structured, audience-aware technical documentation.

## Install

```bash
npx skillstore add sickn33/docs-architect
```

## Metadata

- Status: approved
- Slug: sickn33-docs-architect
- Skillstore revision: r1
- Version status: missing
- Tree hash: 8f854187f5dff9414fa63ddd0606b62e8ceb3680c9dc22a6563dc2b204194aa7
- Author: sickn33
- GitHub username: sickn33
- License: MIT
- Repository: https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/docs-architect
- Ref: f9e2c34b4f19c7f3e6b0a1e93227b5f77cc12526
- Supported tools: Claude, Codex, Claude Code
- Audit status: complete
- Agent install advisory: allowed
- Manual install advisory: allowed
- Artifact signature: available
- Audit attestation: unavailable
- Human verification: not\_verified
- Risk factors: external\_commands
- Quality score: 78
- Quality tier: bronze
- Public page: https://skillstore.pages.dev/skills/sickn33-docs-architect
- Manifest: https://skillstore.pages.dev/api/skills/sickn33-docs-architect/manifest

## Capabilities

- Guides analysis of code structure, dependencies, components, design patterns, data flows, and integration points.
- Builds documentation hierarchies that progress from executive summaries to implementation details.
- Explains architectural decisions with rationale and concrete evidence from the codebase.
- Produces Markdown with headings, tables, lists, notes, examples, cross-references, and file citations.
- Plans architecture, sequence, and flow diagrams through detailed textual descriptions.
- Creates reading paths for developers, architects, operators, and other stakeholders.

## Use Cases

- Accelerate Developer Onboarding: Create a guided system overview with component responsibilities, data flows, local setup context, and focused reading paths.
- Prepare Architecture Reviews: Document system boundaries, integration points, design decisions, security controls, performance characteristics, and operational tradeoffs.
- Preserve System Knowledge: Turn implementation details and historical decisions into a maintainable reference for future changes and incident analysis.

## Prompt Templates

### Document One Component

```
Analyze [component path]. Create a Markdown overview covering purpose, responsibilities, dependencies, public interfaces, and one concrete usage example. Cite relevant files and line numbers.
```

### Create an Onboarding Guide

```
Analyze [repository scope] for new [role] team members. Explain the system overview, key workflows, important modules, terminology, and a recommended reading path. Cite repository evidence.
```

### Map the System Architecture

```
Document the architecture of [system scope]. Cover boundaries, components, dependencies, data flows, integrations, deployment, security, and performance. Describe suitable architecture and sequence diagrams.
```

### Produce a Technical Manual

```
Create a staged technical manual for [repository]. Define the chapter plan first, then document each approved section with citations. Reconcile terminology, cross-references, assumptions, and unresolved questions.
```

## Limitations

- Documentation quality depends on access to complete, current source code and project context.
- The skill does not test code, inspect live environments, or verify operational claims.
- Visuals are described in Markdown and may require separate rendering tools.
- Large manuals may require staged generation to fit model context limits.

## Best Practices

- Provide repository scope, target audience, desired depth, and required output format before analysis begins.
- Require every technical claim to cite current files and line numbers.
- Generate large manuals in reviewed sections, then reconcile terminology and cross-references.

## Anti Patterns

- Do not request a definitive architecture guide from incomplete or outdated source material.
- Do not accept inferred behavior as fact when repository evidence is missing.
- Do not combine every audience into one undifferentiated document.

## Security Audit

- Audited at: 2026-07-23T22:42:02.784\+00:00
- Summary: The single static finding is a false positive: SKILL.md line 24 uses Markdown backticks around a resource path, not shell execution. The skill contains instructions only and defines no executable behavior. No prompt injection or other intent-based security issue was found.

## Stats

- Views: 104
- Downloads: 10
- Favorites: 1
- Popularity score: 0