project-init

Name: project-init
Availability: InStock
Author: avav25

Generate root and scoped AGENTS.md, ARCHITECTURE.md, and TESTING.md files for Windsurf projects.

2|Updated Mar 19, 2026

Search Tags:#architecture #documentation #monorepo #project-setup #windsurf #initialize #agents-md

Ready to run

npx skills add https://github.com/avav25/ai-assets --skill project-init-avav25

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: project-init
Source: https://github.com/avav25/ai-assets/tree/main/.windsurf/skills/project-init
Command: npx skills add https://github.com/avav25/ai-assets --skill project-init-avav25

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Initialize Windsurf project context for an existing repository by generating root and scoped AGENTS.md files, plus supporting ARCHITECTURE.md and TESTING.md documentation.

Core Features & Use Cases

Generates a root AGENTS.md outlining product purpose, service map, mandatory rules, and repository structure for Windsurf projects.
Produces scoped AGENTS.md files for significant directories to codify local conventions and workflows.
Creates ARCHITECTURE.md and TESTING.md to document system design, runtime, data flows, and testing strategy.
Produces a concise project map and references to accelerate Windsurf onboarding and integration.

Quick Start

Run the Windsurf project-init workflow to scan the repository and generate the root and scoped documentation files.

Frequently Asked Questions about project-init

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

FAQPage Schema

How do I initialize Windsurf project context for an existing repository?▼

To initialize Windsurf project context, run the project-init workflow to scan your repository and automatically generate root AGENTS.md, ARCHITECTURE.md, and TESTING.md files. This establishes a clear project map and local guidance for Windsurf onboarding.

What is an AGENTS.md file and how does it structure monorepo project setup?▼

An AGENTS.md file outlines product purpose, service maps, mandatory rules, and repository structure for Windsurf projects. In a monorepo setup, scoped AGENTS.md files can be generated for significant directories to codify local conventions and workflows.

Does the generated ARCHITECTURE.md document system design and data flows?▼

Yes, the generated ARCHITECTURE.md documents system design, runtime environments, and data flows. It works alongside TESTING.md to define testing strategy, providing comprehensive project documentation to accelerate AI agent integration.

Can I use this project initialization workflow for multi-package projects?▼

Yes, you can use this workflow for multi-package or monorepo projects. It applies to repositories with multiple significant directories by producing a root project map and optional scoped AGENTS.md files for directories that warrant dedicated guidance.

What's the best way to document local conventions across significant directories?▼

The best way to document local conventions is generating scoped AGENTS.md files for significant directories. This approach codifies directory-specific workflows and rules, creating clear local guidance that accelerates onboarding and standardizes project setup.