MyJackfruit

Help
Browse topics · Development

Development

← Development

Will my AI write down how my app works, so someone else can take over?

Short answer

Partly: it keeps a project index and comments in the code, and a handoff when you close a session; ask for a full guide.

Before you start

Words used here (3)
project
A project is work to bring about a change you want, such as a new app or a better way of doing something.
handoff
A handoff is the note Kai-Zen writes when a session ends: what was done, what is open, and where to start next time.
session
A session is one stretch of work with an agent, from its start until you close it; with Kai-Zen it ends in a handoff.
Deeper

Also asked:

Will someone else understand how my app works later? Partly: your AI writes notes in the code, a project index and handoffs, but no guide to the whole app unless you ask for one. Someone who takes over needs the code, or its copy on GitHub, and access to the project's vault.

Several things are written down as your app is built, by the rules your AI's agents follow. An agent is your AI following one written procedure, its standing instructions, for one kind of work.

In the code. Agent.Coder, the agent that writes your app's code, starts every file with a short note on what it is for, and adds notes inside the code that say why something was done, not what it does. Its rules ask for plain English, short sentences, written as if explaining to a smart person who has never seen this code before.

In the project folder. Agent.Coder keeps a project index, updated after each piece: where the plan is, the test reports (what the checks on the code showed), and the parts the app is built from. It also keeps a list of which parts each app uses, and which version. Each version of the code it saves carries a message saying what changed and why.

In the plan. Kai-Zen, the planning agent, keeps the project's plan, reports and handoffs where the project is kept: in its vault, in a folder on your computer, or both. The plan says whom the app is for, what it must do, how good it must be, the ways to build it, its limits and its steps. A handoff is the note Kai-Zen writes when you end a session: what was done, what is open and where to start next time.

What is not written by itself. None of these rules asks your AI for a guide that explains the whole app to a new developer, or a manual for the people who use it. Ask for one in your own words, for example: Write a guide to this app for a developer who will take it over.

For someone to take over, they need the code and the plan: the folder where the code is built or its copy on GitHub, a website where programmers keep and share code (Agent.Coder's rules require that copy), and access to the project's vault. The answer Can a developer or a friend help me? shows how to share a vault. GilbApp's chat reaches a folder on your computer only when Claude Code, Anthropic's AI that you run in Terminal, the window where you type commands, is connected to it and a code folder is switched on (Choose a code folder, then Code in); otherwise code kept there needs Claude Code in Terminal. Tell your AI to make the GitHub copy private, unless you want everyone to see your code.

This answer is written for a computer screen.

Source: Standards: Rule_Code_commenting (RuleCommentTwoLevels, RuleCommentIntent, RuleCommentTone, RuleCommentFileHeader), Agent.Coder (Tier2, ProjectFolders: project index and dependency map), Rule_Code_git-workflow (RuleGitworkCommit), Kai-Zen.ProjectRules.Files, Kai-Zen.Close.Handoff. Live help pages, sentences shared: Where is what I tell Kai-Zen written down, and where is my plan kept? (plan contents; handoff); Can a developer or a friend help me?; Do I need a GitHub account?; Will I understand what the AI built, and can I learn to code along the way?.

Checked against GilbApp d529620.