跳到正文
cccskills
免费在 GitHub 公开

codebase-onboarding

Analyze a codebase to draft onboarding documents covering project structure, technologies, local setup, and common tasks. Tailor the depth for junior engineers, senior developers, or contractors, with troubleshooting guidance and contribution checklists.

中文简介正在准备中。当前显示英语简介。

原文查看原文说明

Analyze a codebase and generate onboarding documentation for engineers, tech leads, and contractors. Fast fact-gathering and repeatable onboarding outputs. Use when onboarding a new engineer, writing architecture-overview docs for a new project, or producing tech-lead briefings for unfamiliar repos.

查看安装方法

适用场景

  • Onboarding a new engineer or contractor
  • Updating project guides after a major refactor
  • Preparing technical handoff documentation
  • Briefing a tech lead on an unfamiliar codebase

包含的文件(4)

  • SKILL.md2.5 KB
  • references/onboarding-template.md3.3 KB
  • references/output-format-templates.md978 B
  • scripts/codebase_analyzer.py5.4 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

Codebase Onboarding

Tier: POWERFUL
Category: Engineering
Domain: Documentation / Developer Experience


Overview

Analyze a codebase and generate onboarding documentation for engineers, tech leads, and contractors. This skill is optimized for fast fact-gathering and repeatable onboarding outputs.

Core Capabilities

  • Architecture and stack discovery from repository signals
  • Key file and config inventory for new contributors
  • Local setup and common-task guidance generation
  • Audience-aware documentation framing
  • Debugging and contribution checklist scaffolding

When to Use

  • Onboarding a new team member or contractor
  • Rebuilding stale project docs after large refactors
  • Preparing internal handoff documentation
  • Creating a standardized onboarding packet for services

Quick Start

# 1) Gather codebase facts
python3 scripts/codebase_analyzer.py /path/to/repo

# 2) Export machine-readable output
python3 scripts/codebase_analyzer.py /path/to/repo --json

# 3) Use the template to draft onboarding docs
# See references/onboarding-template.md

Recommended Workflow

  1. Run scripts/codebase_analyzer.py against the target repository.
  2. Capture key signals: file counts, detected languages, config files, top-level structure.
  3. Fill the onboarding template in references/onboarding-template.md.
  4. Tailor output depth by audience:
    • Junior: setup + guardrails
    • Senior: architecture + operational concerns
    • Contractor: scoped ownership + integration boundaries

Onboarding Document Template

Detailed template and section examples live in:

  • references/onboarding-template.md
  • references/output-format-templates.md

Common Pitfalls

  • Writing docs without validating setup commands on a clean environment
  • Mixing architecture deep-dives into contractor-oriented docs
  • Omitting troubleshooting and verification steps
  • Letting onboarding docs drift from current repo state

Best Practices

  1. Keep setup instructions executable and time-bounded.
  2. Document the "why" for key architectural decisions.
  3. Update docs in the same PR as behavior changes.
  4. Treat onboarding docs as living operational assets, not one-time deliverables.

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Audit web applications for accessibility issues against WCAG 2.2 Level A and AA, the web accessibility standards. Get framework-specific code fixes, contrast checks, verification steps, and reports, with options for automated checks in development pipelines.

中文简介正在准备中。当前显示英语简介。

  • Audit a web application before release
  • Fix contrast and keyboard navigation issues
  • Prepare accessibility reports for stakeholders
alirezarezvani/claude-skills2.8万2026年8月30日 更新

Plan A/B tests that compare page variations, from headlines to pricing layouts. Define a hypothesis, choose success metrics, calculate sample size and duration, and prepare launch checks and results reports to support decisions.

中文简介正在准备中。当前显示英语简介。

  • Comparing landing page headlines
  • Testing signup button changes
  • Planning pricing page experiments
alirezarezvani/claude-skills2.8万2026年8月30日 更新

Create paid ad headlines and body copy tailored to each platform's character limits. Use existing performance data to develop variations, explore new messaging angles, and check copy for length, quality, and potential rejection risks.

中文简介正在准备中。当前显示英语简介。

  • Creating Google RSA headlines
  • Writing Meta and LinkedIn ad copy
  • Developing variations of successful ads
alirezarezvani/claude-skills2.8万2026年8月30日 更新

Review code changes from three critical perspectives: production failures, maintainability, and security. Get a consolidated report that ranks findings by severity and provides merge guidance, helping examine assumptions that an ordinary self-review may overlook.

中文简介正在准备中。当前显示英语简介。

  • Reviewing a pull request before merging
  • Getting a second opinion on AI-written code
  • Checking authentication or data access code
alirezarezvani/claude-skills2.8万2026年8月30日 更新

aeo

免费

Audit and improve content intended for citation in AI answers. Review evidence, author information, and structure, generate revised content and structured metadata, and keep a local record of observed citations across AI services.

中文简介正在准备中。当前显示英语简介。

  • Audit existing articles for evidence and credibility gaps
  • Revise article structure and references for AI answers
  • Record citations observed across AI services
alirezarezvani/claude-skills2.8万2026年8月30日 更新

Create signed records for consequential agent actions such as deployments, deletions, and payments. Decide which actions need evidence, record the agent, action, target, and policy, then verify the resulting certificate offline to detect later changes.

中文简介正在准备中。当前显示英语简介。

  • Creating signed records for production deployments
  • Preserving evidence of deletions and payments
  • Recording access grants for later review
alirezarezvani/claude-skills2.8万2026年8月30日 更新

查看 alirezarezvani 的全部技能

报告此技能的问题