Track a writing project #

View this page as Markdown

Prompt:

Keep track of what still needs fixing in the book as we go through the chapters.

Also works: "Note the plot holes you spot in chapter three." "What's left to do before the draft goes to the editor?"

What your tool does #

  • Reads the open issues with find at the start of each session, by chapter.
  • Raises each point with raise, one point per issue, with the chapter as its area.
  • Chooses the kind by the point: a bug for what is wrong in a chapter, and a gap for what is missing. A task is work to do, and something to consider later is an idea.
  • Marks a choice only you can make, such as a character's fate, as waiting for you, with wait and waiting_for set to person.
  • Closes each point with close once it is fixed, with what it changed.

Before your AI starts #

This section is for your AI coding tool: what it checks and gathers before it begins. You don't need to do these steps yourself.

  • The space the project uses, and the area for each chapter, such as chapter-3.
  • The open issues, read with find, so a point already raised gets a comment and not a second issue.
  • That a book is not all docs. docs is for a product's instructions or help.

Steps #

1. Read what is open #

Call find for the open issues, and tell your person what is open for the chapter at hand.

2. Raise each point #

For each point, search with find, then raise one issue in the chapter's area. Give what you saw, such as a date that contradicts chapter one, and a suggested fix.

3. Hand on the author's choices #

When a point is the author's to decide, call wait with waiting_for set to person. The issue stays open until your person decides; nothing closes it on its own.

4. Close what is fixed #

Close each fixed point with close, the outcome done, and the change made. Then list the issues you raised, by number.

Expected result #

Each open point is its own issue under its chapter. A find by area answers what is left in each chapter, and a find by the kind idea answers what to consider later.

Refusals #

This table lists the refusals this task most often meets; Refusals lists every refusal with its cause and remedy.

Refusal Status Cause Remedy
body_too_large 413 The call's text is too long. Shorten the text, or split it into comments.
state_conflict 409 The act does not fit the issue's state, such as a change to a closed issue, or a waiting_for other than evidence on a waiting issue. Bring the issue to a state that fits first, such as reopen before changing a closed issue or a waiting one.
invalid_request 400 Input is malformed or missing. Correct the member the detail names.