What goes in a guide and what belongs in the reference?
Write a guide to show a developer how to finish a task, such as finding an order. Supply an OpenAPI description, a file that lists each request and its inputs, to generate the reference for the individual requests. ReadMe can also create reference pages manually.
Who can see a change before it goes live?
ReadMe lists built-in branching and reviews starting on Pro. A branch is a separate copy of the docs where you can review edits before merging. On Starter, keep a review draft outside the live docs and copy the approved text when ready. A share link on a public ReadMe project can let an outside reviewer open that branch. A page hidden from navigation can still be opened by its direct link. Keep sensitive material in an approved private location and verify who can open it before sharing.
What can you start with on the free plan?
ReadMe lists Starter at no charge with the Markdown editor, interactive reference and two-way sync. Check the plan if you need more administrators or reader answers. Ask AI can link readers to the published pages it used, with availability depending on plan and add-ons.
What should you download separately when moving?
The branch file export is a ZIP that includes OpenAPI files and image paths. It leaves out the images themselves. Keep a separate copy of those images. The PDF export is narrower and covers guides and their included components.
How would you prepare one order lookup for another developer?
Sketch this with fictional material. Leave the real site, accounts and services alone.
- Write the jobUse a made-up order number and describe what a developer should see if the order exists.
- Mark the reference fieldsDraw the request input and the expected response fields on a separate card. Use no working account, server or token.
- Plan the handoffMark which guide, reference file and screenshot you would save before replacing the site.