skills.rest
Suge8
Suge8COMMUNITY
Explore all skills by this author →
WebsiteGitHub

project-setup

Audit project documentation skeletons and route gaps to specialized skills.

Updated Sep 14, 2026
Search Tags:#github#project setup#agents.md#documentation audit#open source checklist#verification chain#testing toolchain
One-click install
npx skills add https://github.com/Suge8/skills --skill project-setup-suge8
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: project-setup
Source: https://github.com/Suge8/skills/tree/main/development/project-setup
Command: npx skills add https://github.com/Suge8/skills --skill project-setup-suge8

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Projects often lack a consistent documentation skeleton—missing AGENTS.md, CONTEXT.md, LICENSE, or CONTRIBUTING files—and teams don't know what's missing before open-sourcing or mid-development. This Skill performs a read-only health check of your project's docs and verification toolchain, then routes each gap to the right specialist instead of producing content itself. ## Core Features & Use Cases - Documentation Health Check: Explores the repo read-only, then outputs a checklist table marking each required document (AGENTS.md, CONTEXT.md, LICENSE, README, CONTRIBUTING, SECURITY) as present, missing, or not applicable. - Verification Chain Audit: Compares the project's test/lint/format setup against a qualified verification-chain standard covering Tauri, Electron, browser extensions, web, CLI, and library projects. - Gap Routing: Delegates missing pieces to the right owner—domain-modeling for CONTEXT.md, copywriting/stop-slop for community files—rather than writing everything itself. - Use Case: Before open-sourcing a side project, run this Skill to discover you're missing a LICENSE and SECURITY.md, get a per-section confirmation flow with recommended answers, and have each gap dispatched to the appropriate skill. ## Quick Start Ask the agent to run project-setup on this repository and report what documentation or verification-chain pieces are missing.

Frequently Asked Questions about project-setup

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check what documentation my project is missing?▼

Run a documentation health check that inventories AGENTS.md, CONTEXT.md, README, LICENSE, CONTRIBUTING, and SECURITY files against a standard skeleton. The audit outputs a table marking each item as present, missing, or not applicable, with a recommended action for every gap.

What files does a project need before open-sourcing on GitHub?▼

Open-source projects need a LICENSE at the root for GitHub sidebar detection, a user-facing README, plus CONTRIBUTING.md and SECURITY.md which can live in .github/ to keep the root clean. High-frequency entry files stay at root while deep content like PRDs and ADRs belongs in docs/.

What makes a test verification chain acceptable for AI agents?▼

A qualified verification chain runs independently without human clicks, executes headless or isolated, produces repeatable results without sleeps or live network, and asserts concrete behavior rather than just not crashing. Configured formatter checks, lint, and typecheck must connect to the same repeatable entry point.

Does this project audit modify or rewrite existing files?▼

No, the exploration step is strictly read-only and existing documents are never rewritten. It only reports gaps when content clearly diverges from reality, and proposes merging when the same fact exists in two places, keeping the copy under docs/.

When should I not use a documentation skeleton audit?▼

Do not use it for UI design work, feature development, or release publishing—those belong to dedicated skills like ui-craft or ship. The audit only inventories gaps and routes work; it deliberately does not generate content itself.

Related Skills

Explore More Software Engineering Skills→
catalystctlcatalystctl
10

codebase-overview

Inspects repository structure, README, and manifests to produce a concise codebase overview.

Official
Basic
Andamio-PlatformAndamio-Platform

documentarian

Review code changes and update README, CHANGELOG, and skill references.

Official
Advanced
andregusman-raizandregusman-raiz
19

ag-referencia-qualidade

Enforce quality gates, post-execution checklists, and CI metrics in software projects.

Community
Advanced
nashgaonashgao
3

Intelligent Scaffolding

Analyze project patterns to generate code, tests, and documentation for new features.

Community
Advanced