Project Doc Initializer
Paste the following prompt into your AI chat to install this skill:
Please install @user_81da3431/project-doc-init according to https://skillhub.cn/install/skillhub.md.
About this skill
Problem
Many code projects lack a single entry point for engineering and AI-assisted work: behavior rules, directory conventions, common commands, and API expectations are often scattered across chat threads or tribal knowledge. project-doc-init addresses this by inspecting the project itself, identifying the tech stack and architecture, and generating a maintainable AGENTS.md plus optional docs/ sub-docs with clear lookup paths.
How It Works
The skill runs without extra parameters. It reads configuration files and directory structure, detects project types such as Vue, React, Node, Go, and Python, and chooses documentation granularity based on project complexity:
- AGENTS.md: behavior rules, scenario-based navigation, and common commands as the primary entry point.
- docs/PROJECT.md: baseline information such as tech stack and directory layout.
- Specialized docs: docs/API.md, docs/COMPONENT.md, docs/ARCHITECTURE.md, or docs/DATA_MODEL.md are generated only when interfaces, components, architecture, or data models warrant separate documentation.
Paths use relative paths for portability; small projects may only produce AGENTS.md and docs/PROJECT.md.
Boundaries
This skill is intended for code projects with an existing structure and does not assume a fixed template. If key files such as package.json or go.mod are missing, or the tech stack cannot be identified, it generates only baseline documentation from confirmed information and asks the user about uncertain parts; when configuration is absent, it does not force dynamic specialized docs.
Use Cases
- After taking over a Vue repo, quickly summarize the tech stack, directory layout, and common commands into one entry doc.
- In a Node CLI tool, collect parameter notes, tech stack, and directory conventions into baseline project docs.
- For a split frontend-backend project, split API conventions, architecture decisions, and data model notes into docs.
- When config files are missing, generate only confirmed AGENTS.md and PROJECT.md from the directory structure.
Best For
- Frontend leads maintaining Vue repos who need to consolidate component rules and common commands into one entry doc.
- Backend engineers taking over Node CLI tools who need quick notes on parameters, stack, and directory conventions.
- Tech leads maintaining full-stack projects who need separate docs for APIs, architecture decisions, and data models.
- Engineering owners configuring coding agents who need stable behavior rules and scenario-based project navigation.
Related Skills
A one-shot coding agent built on Claude Code CLI that runs non-interactively, supports a specified workdir, and can be monitored in the foreground or background.
Preview and confirm file sorting by extension, with recursive cleanup, ignore rules, and transactional rollback.
An engineering assistant for static HTML/CSS/JS pages, design-token extraction, IE8-compatible review, and structured delivery.
An engineering workflow for requirement analysis, scenario modeling, risk planning, quality gates, testing, and knowledge capture, with lightweight, standard, and full modes.