Skip to content

Latest commit

 

History

History

README.md

manual/ Folder Rules

Purpose

Store Hyper-Waterfall operating rules, repository adoption procedures, and repeatedly applied work standards.

Questions Answered

  • "What rules operate this repository?"
  • "Which document should be checked to change a procedure?"

When to Write

When procedures, branch policy, PR policy, document structure, or conflict rules change.

Allowed Filenames

Use snake_case Markdown names that reveal the topic. Examples:

  • document_structure_guide.md
  • task_workflow_guide.md
  • git_workflow_guide.md
  • pr_process_guide.md
  • internal_pr_guide.md
  • external_pr_review_guide.md
  • pr_command_guide.md
  • framework_lifecycle_guide.md
  • release_update_protocol.md
  • agent_code_hyperfall_rule_conflict.md

Template Used

Use mydocs/_templates/tech_note.md as a draft structure when helpful, but manual documents should prioritize their topic-specific structure.

Required Content

  • Purpose
  • Scope
  • Mandatory rules
  • Exceptions
  • Related manual links

Content Not Allowed

  • Stage reports for a specific task
  • Completion reports
  • Daily task status tables
  • Product, user, contributor, or API contract documentation for the target project

Context the Next Session AI Must Restore

The current procedural baseline and how it relates to other documents.