Skip to content

[Docs]: Guidance for how feature specific docs should be kept #281

@robertlarkins

Description

@robertlarkins

Type of Documentation Problem

Missing documentation

Location

https://github.com/awslabs/aidlc-workflows#version-control-recommendations

Description

The documentation is unclear about the life cycle of feature specific context files. When going through the phases for a change or feature, the AI generates files under /aidlc-docs. At the completion of the feature, what should be done with the feature specific files? Should they be:

  • Kept in the repo in perpetuity, with each change and feature getting a new set of folders?
    • This can bloat out the repo, consuming future context (unless specifically ignored).
  • Shift the files to a history / archive / completed folder? Then this folder can be explicitely set to be ignored by the AI?
  • Delete the feature files, relying on the git history to maintain them?
  • Something else?

Also, is there a recommended process for managing multiple features being created in parallel? Does the AI manage their naming under /aidlc-docs? How should the context of one be kept separate from the other?

Suggested Fix

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions