|
| 1 | +This folder is the working scratchpad for user+assistant development. |
| 2 | + |
| 3 | +# Conventions |
| 4 | + |
| 5 | +files prefixed with `u.` are user-authored. |
| 6 | +files prefixed with `a.` are assistant-authored. |
| 7 | + |
| 8 | +Other files are sourced as general context or informtion relevant to the current mission. |
| 9 | + |
| 10 | +The user will annotate / edit assistant files in order to specifically direct feedback to the assistant's work. |
| 11 | + |
| 12 | +# General Expected Workflow |
| 13 | + |
| 14 | +We are a document-centric team, you and I. |
| 15 | + |
| 16 | +Turn 0 (user): |
| 17 | +- user will include a file like `issue.md`, `failure.log`, or something different. |
| 18 | +- user will supply it to an assistant, along with supporting context in the prompt if necessary. |
| 19 | + |
| 20 | +Turn 1 (assistant): |
| 21 | +- assistant will read the file, *look around*, and write `a.assessment.md` |
| 22 | + |
| 23 | +a.assessment.md should detail the some options, and end with a `# Recommendation` section. |
| 24 | + |
| 25 | +Turn 2 (user): |
| 26 | +- User will read assessment and either: |
| 27 | + - provide more context as necessary, |
| 28 | + - ask follow-up questions, or |
| 29 | + - select a promising option from the assessment |
| 30 | + |
| 31 | +If the user provides or asks for more info, assistant will discuss and together they will refine the assessment. |
| 32 | + |
| 33 | + |
| 34 | +If the user makes a selection: |
| 35 | + |
| 36 | +turn 3 (assistant): |
| 37 | +- assistant will create `a.plan.md` and `a.todo.md`. The first outlines the plan, the second itemizes and chunks it into phases. |
| 38 | + |
| 39 | + |
| 40 | +At this point we are into the main loop of the session. |
| 41 | + |
| 42 | +{{ |
| 43 | +Main Loop: |
| 44 | + |
| 45 | +- User will assign chunks of tasks from the todo list to the assistant |
| 46 | +- Agent will attempt to complete the tasks. |
| 47 | + - if successful, assistant will write and `a.next.md` with a suggested next chunk |
| 48 | + - if unsucessful, we break the flow and debug / rethink together |
| 49 | + |
| 50 | + |
| 51 | + |
| 52 | +- User will review the assistant changes, and: |
| 53 | + - if satisfied, indicate so and either: |
| 54 | + - ask the assistant to carry on with their `a.next.md` suggestion |
| 55 | + - redirect to a different set of tasks |
| 56 | + - if unsatisfied, main loop breaks and we debug / rethink together |
| 57 | + |
| 58 | + |
| 59 | +Where a user approves the changes, before moving on, the assistant will update the `a.todo.md` file to reflect completed and potentiall *in flight* tasks. |
| 60 | + |
| 61 | +At the end of each agentic turn, assistant can rewrite `a.next.md` from scratch. |
| 62 | + |
| 63 | +}} |
| 64 | + |
| 65 | +# General Notes |
| 66 | + |
| 67 | +## Task Focus |
| 68 | + |
| 69 | +When performing tasks, the assistant should attempt to be narrowly focused on the specific designated task or task chunk. |
| 70 | + |
| 71 | +If, in the process of a task, the assistant discovers tangential issues, issues unrelated to the current task, or similar, the assistant should create a **new working document** for the discovered issue. The created working document should have a title roughly in the format of `a.aside.<category>.<title>.md`. |
| 72 | + |
| 73 | +eg: `a.aside.perf.many-round-trips-in-reviews-lookup.md`, `a.aside.security.addCourse-endpoint-not-authenticated.md`, etc. |
| 74 | + |
| 75 | +The agent should expect the user to review these asides async to the current main workflow. |
| 76 | + |
| 77 | +# Coda |
| 78 | + |
| 79 | +This document and flow are experimental. If, experientially, it feels like it is not working, we can change it. Open to suggestions! |
| 80 | + |
| 81 | +Thank you! |
0 commit comments