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/onboarding.md

View on GitHub
# {{PROJECT_NAME}} - Developer Onboarding Guide

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

Welcome to {{PROJECT_NAME}}. This guide gets a new developer to a running
local environment.

## Prerequisites

- {{TECH_STACK_REQUIREMENTS}}
- Git
- {{ADDITIONAL_ACCOUNTS}}

## Setup

```mermaid
flowchart TD
    A[Clone Repository] --> B[Install Dependencies]
    B --> C[Environment Setup]
    C --> D[Database Setup]
    D --> E[Run Tests]
    E --> F[Start Dev Server]
```

### 1. Clone and Install

```bash
git clone {{REPOSITORY_URL}}
cd {{PROJECT_NAME}}
{{INSTALL_COMMANDS}}
```

### 2. Environment Configuration

```bash
cp .env.example .env
# Edit .env with local values
```

### 3. Database Setup

<!-- Delete this step if the project has no database. -->

```bash
{{DATABASE_SETUP_COMMANDS}}
```

### 4. Verify

```bash
{{TEST_COMMANDS}}
{{DEV_SERVER_COMMANDS}}
```

## Development Workflow

**Branches:** {{BRANCH_STRATEGY}}

**Commits:** {{COMMIT_CONVENTION}}

**Before opening a PR:**
- Run linters/formatters
- Run tests locally
- Update docs for API/behavior changes

## Project Structure

```
{{PROJECT_STRUCTURE}}
```

## Common Tasks

### Adding a Feature

1. Create a branch
2. Implement, following the project's coding standards ([contributing.md](contributing.md))
3. Add/update tests
4. Open a pull request

### Fixing a Bug

1. Reproduce with a failing test
2. Fix the root cause
3. Open a pull request

## Troubleshooting

<!-- One entry per real, recurring setup issue this project has (from issues,
     README caveats, or a wiki). Delete if none are documented. -->

**{{COMMON_ISSUE}}:** {{SOLUTION}}

## Resources

- [Architecture Documentation](architecture.md)
- [Contributing Guidelines](contributing.md)
- {{ADDITIONAL_RESOURCES}}

---

*Found something outdated here? Open a PR: this doc is meant to be kept current.*
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