Help your agent write useful product guidance
The authoring guide asks the coding agent to start with the reader’s task and verify the product facts behind every instruction. It turns source knowledge into guidance for customers and administrators rather than a tour of framework internals.
Example — Explain how an administrator invites a colleague
The agent checks the actual invite action, required authority, expected result and recovery path before writing the steps a customer should follow.
For engineers
The installed application-consumer-documentation-authoring skill separates application-consumer writing from framework-developer knowledge. It asks for a source-fact matrix and verification of the steps, terminology, permissions and linked contracts.
| Reader question | Evidence to inspect | Writing consequence |
|---|---|---|
| Where do I start? | Existing screen or entry point | Name a reachable starting point |
| Who can do this? | Accepted authority and scope | State the actual prerequisite |
| What happens next? | Operation and visible result | Explain the outcome, not the implementation loop |
| What if it fails? | Validation and recovery behavior | Give a useful next action |
For a guide that points into API reference, use a semantic target rather than inventing a generated URL. This illustrative target names the normal reference root:
const referenceTarget = {
section: TechnicalDocumentationApiReferenceSection.API_REFERENCE,
kind: TechnicalDocumentationApiReferenceTargetKind.ROOT,
};
The target vocabularies are exported by @wildo-ai/saas-specifications/technical-documentation; the publication renderer resolves targets against the emitted reference. This is target data used by the supported documentation link model, not a complete article-registration API.
Keep authoring and publication distinct
A skill can guide writing without creating an application-local input to the managed publication pipeline. The current engine-owned catalogue and projected application facts have their own acceptance path. Confirm where an authored article will be accepted and rendered before treating a repository Markdown file as part of the managed portal. Installing the guide does not itself add that publication input.