Skip to content

mgiovani/ai-arsenal / skills/docs-init

docs-init

Verified

Bootstraps a documentation structure (architecture, onboarding, data-model, deployment, security, contributing, and a first ADR) for a project that has little or no docs/ directory, exploring the codebase and populating templates only with content evidenced in the code. Use when the user wants to set up docs, bootstrap documentation, initialize project docs, scaffold a docs/ folder, or create docs from scratch for a new or undocumented project. Not for refreshing or syncing docs that already exist (use docs-update). Not for generating a standalone architecture or ER diagram without the surrounding document (use docs-diagram).

assets/templates/architecture.md

View on GitHub
# {{PROJECT_NAME}} Architecture

**Last Updated:** {{DATE}}

## Overview

{{OVERVIEW}}

[2-3 sentences: what this system does, key characteristics.]

## System Context

{{SYSTEM_CONTEXT}}

[What external systems does it talk to? Who/what are the callers?]

## Goals and Non-Goals

### Goals

{{GOALS}}

### Non-Goals

{{NON_GOALS}}

## Core Components

<!-- One subsection per real component/module/service found in the codebase.
     Duplicate this block per component; delete if the system has only one. -->

### {{COMPONENT_NAME}}

{{COMPONENT_DESCRIPTION}}

**Responsibilities:** {{COMPONENT_RESPONSIBILITIES}}

**Dependencies:** {{COMPONENT_DEPENDENCIES}}

## Data Flow

{{DATA_FLOW}}

[Typical request/response or event flow through the components above.]

## Technology Stack

{{TECHNOLOGY_STACK}}

## Security Considerations

{{SECURITY_CONSIDERATIONS}}

[Only what the codebase actually does: auth mechanism found, secrets handling
observed, etc. Full security posture belongs in security.md.]

## Performance and Scalability

{{PERFORMANCE_SCALABILITY}}

[Known bottlenecks or scaling approach, if evidenced by config/code.]

## Deployment

{{DEPLOYMENT_SUMMARY}}

See [deployment.md](deployment.md) for the full pipeline.

## Future Considerations

{{FUTURE_CONSIDERATIONS}}

[Only if there's a real signal: TODOs, open issues, roadmap doc. Omit if none.]

## References

{{REFERENCES}}

---

*Generated by docs-init. Keep in sync with the codebase, rerun docs-update after
architectural changes.*
rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first.Stars: 194kUpdated Claude CodeCodexVerifiedInstall