Write product user guides with AI
Turn verified product behaviour into instructions people can follow. Use the labels they see, put steps in working order and show what successful completion looks like.
Write product user guides with AI when the release notes explain what the team built but a reader still cannot find last month's invoice. That reader needs a starting point, the label to select and an indication that the correct file has opened.
The writing-user-docs skill works from the reader's task. For a library, that reader may be the developer using its public interface. For an application, it may be someone seeing a feature for the first time. A technical detail earns space when it changes an action, a choice or the result.
What it does
- Choose a single task for a getting-started page
- Use the exact control names found in the product
- Put instructions in the order a reader encounters them
- Describe a visible result or a useful example
- Remove background that does not help complete the task
Install and use
- Install the skill in a compatible agent and supply an audience, a verified workflow and its current interface labels. An authorised screenshot or product note can supply context when the live product is unavailable.
- Ask, “Write a guide to getting a previous invoice. Start in the account screen, use these labels and show what the reader sees after choosing the month.”
- Follow the draft in the product. Revise any step that requires a guess or relies on an undocumented feature.
FAQ
Source
Made by Callstack Incubator. Original skill: writing-user-docs, published on GitHub under the MIT licence.
View on GitHub