mgiovani/ai-arsenal / skills/docs-init
docs-init
VerifiedBootstraps 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).
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 7.9 KB |
| assets/templates/architecture.md | markdown | 1.5 KB |
| assets/templates/contributing.md | markdown | 6.5 KB |
| assets/templates/data-model.md | markdown | 860 B |
| assets/templates/deployment.md | markdown | 1.2 KB |
| assets/templates/onboarding.md | markdown | 1.8 KB |
| assets/templates/security.md | markdown | 1.5 KB |
| evals/evals.json | config | 3.4 KB |
| evals/trigger-eval.json | config | 1.9 KB |
assets/templates/deployment.md
View on GitHub# {{PROJECT_NAME}} - Deployment Guide
**Last Updated:** {{DATE}}
## Overview
{{OVERVIEW}}
## Environments
<!-- One row per environment the codebase actually defines (env files, CI config,
IaC). Delete rows for environments that don't exist. -->
| Environment | Configuration | Access |
|-------------|----------------|--------|
| {{ENV_NAME}} | {{ENV_CONFIG}} | {{ENV_ACCESS}} |
## CI/CD Pipeline
{{CICD_PIPELINE}}
[Describe the real pipeline found in .github/workflows, .gitlab-ci.yml, etc.
Build steps, test gate, deploy trigger.]
## Infrastructure
{{INFRASTRUCTURE}}
<!-- Include only the artifacts that actually exist in the repo (Dockerfile,
k8s manifests, Terraform). Link to the real file instead of pasting it
if it's long. -->
## Monitoring and Alerting
{{MONITORING_ALERTING}}
[Only tools with evidence in the repo: a Sentry/Datadog config, a
prometheus.yml, health-check routes.]
## Rollback Procedure
{{ROLLBACK_PROCEDURE}}
## Scaling
{{SCALING_STRATEGY}}
[Omit if nothing in the repo indicates a scaling strategy beyond defaults.]
## Troubleshooting
{{TROUBLESHOOTING}}
## References
- [Architecture Documentation](architecture.md)
---
*Keep this document updated with infrastructure and deployment changes.*
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| 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: 471k | Updated | Claude CodeCodex | Verified | Install |
| 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: 471k | Updated | Claude CodeCodex | Verified | Install |
| rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics. | Stars: 471k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |