Skip to content

[WIP] Define folder-based structure for new features#1

Merged
co0p merged 1 commit intomainfrom
copilot/define-feature-folder-structure
Nov 24, 2025
Merged

[WIP] Define folder-based structure for new features#1
co0p merged 1 commit intomainfrom
copilot/define-feature-folder-structure

Conversation

Copy link
Copy Markdown

Copilot AI commented Nov 24, 2025

Feature-Based Documentation Structure Implementation Plan

Based on the problem statement, I will implement a structured feature-based documentation workflow:

  • Create features folder structure
    • Create /features/ directory in repository root
    • Add example feature folder structure
  • Create central CONSTITUTION.md in root
    • Move constitution from examples to root (or keep as reference)
    • Update it as the project-wide constitution
  • Create workflow documentation
    • Create WORKFLOW.md in root describing the feature folder process
    • Document roles: Architect/CTO, PO, Solution Architect, Software Engineer
    • Include automated file placement guidelines
  • Create template files
    • Create template for use-case.md
    • Create template for adr.md
    • Create template for tasks.md
  • Update existing instruction files
    • Update create-usecase.md to reference new structure
    • Update create-adr.md to reference new structure
    • Update generate-tasks.md to reference new structure
  • Update README.md
    • Reference the new WORKFLOW.md
    • Update with new feature-based approach
  • Add .gitignore if needed
    • Exclude build artifacts and temporary files
Original prompt

Thank you for this clear and structured workflow. To reflect it in your repository, I will:

  • Define a folder-based structure for each new feature (e.g., /features/[feature-name]/).
  • Specify which documents go in each feature folder and who’s “speaking” through them:
    1. Constitution: Project-wide, authored by architect/CTO. (One in root or /docs? Or always copy into new features for reference?)
    2. Use Case: For each feature, authored by PO.
    3. ADR (Architecture Decision Record): Per feature, by solution architect.
    4. Tasks/Breakdown: Per feature, by software engineer.

Example Structure

/features/
  /[feature-name]/
    constitution.md   # (if a local copy needed, else reference central)
    use-case.md
    adr.md
    tasks.md

Or, if constitution is project-wide:

/constitution.md
/features/
  /[feature-name]/
    use-case.md
    adr.md
    tasks.md

Automated File Placement Flow

When starting a new feature, the AI should:

  1. Create /features/[feature-name]/
  2. Place use-case.md, adr.md, and tasks.md generated for the feature in that folder.
  3. If a central constitution exists, refer to it (link in use-case.md) instead of duplicating it.

I’ll provide a workflow guideline document (for the repo root or /docs) describing this process and update the instructions for the AI, so file placement is always correct.

Would you like:
A. This workflow guideline to be in README.md?
B. Or in a new contributing.md or workflow.md?
C. And should the central constitution file be in repo root or /docs?

Let me know your preferred locations. I’m ready to generate and add the workflow guide and starter templates for each file type (constitution, use-case.md, adr.md, tasks.md) reflecting architect/CTO, PO, Architect, and Software Engineer perspectives.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI self-assigned this Nov 24, 2025
@co0p co0p marked this pull request as ready for review November 24, 2025 04:24
@co0p co0p merged commit cb9f303 into main Nov 24, 2025
1 check failed
Copilot AI requested a review from co0p November 24, 2025 04:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants