Advertisement
Guest User

Workplan Description

a guest
May 18th, 2025
1,913
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 2.39 KB | None | 0 0
  1. ## Task Planning and Execution System
  2.  
  3. ### Workplan Creation
  4. Before implementing any feature or bugfix:
  5. 1. Create a dedicated workplan file in the `Documentation/Plans/` directory with naming format: `TaskID-Description.md` (e.g., `BUG-AuthFlow.md`, `FEAT-Abilities.md`)
  6. 2. Workplan structure must include:
  7. - **Task ID**: Simple identifier for reference (e.g., "FEAT-Abilities", "BUG-AuthFlow")
  8. - **Problem Statement**: Clear definition of what needs to be solved or implemented
  9. - **Proposed Implementation**: Clear and thorough description of a solution that will satisfy the problem statement and implement the desired functionality. It should include what to test and how it should be tested.
  10. - **Components Involved**: Related areas of the system (broader than just files)
  11. - **Dependencies**: Prerequisite knowledge, components, or systems needed
  12. - **Implementation Checklist**: Step-by-step tasks with checkboxes
  13. - **Verification Steps**: How to confirm the implementation works correctly. Verification Steps should always be machine executable (custom scripts, automated tests, CI pass, etc) unless not possible and a human is required.
  14. - **Decision Authority**: Clarify which decisions you can make independently vs which require user input
  15. - **Questions/Uncertainties**:
  16. - *Blocking*: Issues that must be resolved before proceeding
  17. - *Non-blocking*: Issues you can make reasonable assumptions about and proceed
  18. - **Acceptable Tradeoffs**: What compromises are acceptable for implementation speed
  19. - **Status**: One of [Not Started, In Progress, Completed, Blocked]
  20. - **Notes**: Any implementation decisions, challenges, or context for future reference
  21.  
  22. ### Workplan Execution
  23. 1. Update the workplan Status from "Not Started" to "In Progress" when you begin implementation
  24. 2. Check off items in the checklist as they are completed
  25. 3. Add notes about implementation decisions or challenges encountered
  26. 4. For non-blocking uncertainties:
  27. - Document your working assumption
  28. - Proceed with implementation based on that assumption
  29. - Flag the assumption in the Notes section for future review
  30. 5. For blocking uncertainties:
  31. - Document the specific question or issue
  32. - Update status to "Blocked" if you cannot proceed
  33. - Once resolved, document the resolution and continue
  34. 6. Update the Status to "Completed" once all steps are finished and verified
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement