project-foundation

Generate README, .env.example, SECURITY.md, docs/INDEX.md, and ADR-000 files.

Updated Jan 27, 2026
One-click install
npx skills add https://github.com/BrunoSantanaDeveloper/flyeelab-agent-kit --skill project-foundation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-foundation
Source: https://github.com/BrunoSantanaDeveloper/flyeelab-agent-kit/tree/main/skills/project-foundation
Command: npx skills add https://github.com/BrunoSantanaDeveloper/flyeelab-agent-kit --skill project-foundation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Protocol to generate the foundational files for any project (README, .env.example, SECURITY.md, docs/INDEX.md, ADR-000). Used by new-project (Phase 2.05) and legacy-project (Phase 0.7). Context-aware for projects new and legacy.

Core Features & Use Cases

  • Automated foundation generation: Create essential documentation and configuration artifacts for immediate project setup.
  • Context-aware for new vs legacy: Generates from scratch for new projects or updates existing files for legacy codebases.
  • Consistent templates: Ensures README, .env.example, SECURITY.md, docs/INDEX.md, and ADR-000 exist and reflect project stack and environment specifics.

Quick Start

Generate the five foundation artifacts for the project using the provided templates.

Frequently Asked Questions about project-foundation

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

FAQPage Schema
How do I generate foundational project documentation like README and SECURITY.md?

To generate foundational project documentation, this Skill creates README, .env.example, SECURITY.md, docs/INDEX.md, and ADR-000 files automatically. It ensures all artifacts reflect your project's stack and environments, establishing a stable entry point for new repositories or adapting existing legacy files.

What is the best way to set up a .env.example and ADR-000 for a new repository?

The best way to set up a .env.example and ADR-000 is using an automated foundation protocol that generates these artifacts from scratch. This Skill handles the new-project workflow by creating consistent templates tailored to your specific technical stack and environment requirements.

Can I use automated documentation generation for existing legacy codebases?

Yes, you can use automated documentation generation for existing legacy codebases. The Skill applies a legacy-project workflow that adapts and updates your existing README, SECURITY.md, and docs/INDEX.md files rather than overwriting them, ensuring context-aware validation across phases.

How does context-aware project foundation setup handle different tech stacks?

Context-aware project foundation setup handles different tech stacks by analyzing your project's specific technologies and environments. It then generates or updates artifacts like README and .env.example to accurately reflect your stack, ensuring documentation matches your actual configuration.

Do I need any dependencies to automate README and SECURITY.md creation?

No, you do not need any dependencies to automate README and SECURITY.md creation. The Skill operates independently with no required dependencies, allowing you to generate the five foundation artifacts immediately for both new and legacy project workflows.

Why does my project foundation setup require an ADR-000 file?

Project foundation setup requires an ADR-000 file to establish a stable entry point by documenting initial architecture decisions. Generating ADR-000 alongside README and docs/INDEX.md ensures your repository has consistent, validated technical context from the beginning.