project-foundation

Create and persist five JSON project context documents under .devorq/state/.

13|1|Updated Apr 21, 2026
One-click install
npx skills add https://github.com/nandinhos/devorq_v3 --skill project-foundation-nandinhos
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-foundation
Source: https://github.com/nandinhos/devorq_v3/tree/main/skills/project-foundation
Command: npx skills add https://github.com/nandinhos/devorq_v3 --skill project-foundation-nandinhos

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires jq, and includes scripts (resource) components.

What problem does it solve?

DEVORQ-PF v1.0.0 — Documentação estruturada de projeto (5W2H, Premissas, Riscos, Requisitos, Restrições). Cria e valida arquivos persistentes em .devorq/state/. Integra com GATE-0.5 como pré-requisito para qualquer implementação.

Core Features & Use Cases

  • Cria e mantém os 5 documentos de foundation (5w2h.json, premissas.json, riscos.json, requisitos.json, restricoes.json)
  • Valida a prontidão com GATE-0.5 antes de avançar no flow de implementação
  • Oferece templates e migração a partir de SPEC.md para facilitar a decomposição do contexto
  • Persiste estado localmente para handoffs consistentes entre sessões
  • Fornece comandos de wizard/initialização para acelerar a criação de contextos de projeto

Quick Start

Run devorq foundation init in your project root to generate the five foundation documents.

Frequently Asked Questions about project-foundation

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

FAQPage Schema
How do I create structured project context documents for gating and handoffs?

To create structured project context documents, run the initialization wizard in your project root to generate five JSON files covering 5W2H, premises, risks, requirements, and restrictions. These documents persist state locally to ensure consistent context handoffs between sessions.

What is GATE-0.5 readiness validation in project foundation setup?

GATE-0.5 readiness validation is a prerequisite check that enforces formal project context creation before advancing to implementation. It verifies your five foundation JSON documents are properly created and validated to prevent unstructured project execution.

How do I migrate an existing SPEC.md file into structured project context documents?

To migrate an existing SPEC.md file into structured project context, use the built-in migration tools and templates. This decomposes your existing specification context into the five persistent JSON foundation documents stored under the local state directory.

Do I need jq installed to generate and manage project foundation JSON files?

Yes, you need jq installed as a prerequisite dependency to generate and manage project foundation files. The scripts use jq to parse, validate, and manipulate the five JSON context documents stored in your local state directory.

Can I use these project foundation templates for risk and requirements management in any software engineering project?

Yes, you can use these project foundation templates for risk and requirements management across software engineering projects. The generated JSON documents enforce structured ideation and restriction tracking, ensuring consistent gating and state persistence regardless of project scale.

What is the best way to maintain consistent project state across multiple development sessions?

The best way to maintain consistent project state across sessions is persisting context documents locally in a dedicated state directory. This approach stores your 5W2H, premises, risks, requirements, and restrictions as JSON files for reliable handoffs.