Skill instructions
docuwriter-documentation-lifecycle5.71 KB
View saved version →
---
name: docuwriter-documentation-lifecycle
description: Explains repository connection, Full Tree Documentation, Spaces, on-demand repository documentation reviews, and Autopilot. Use for generating, organizing, updating from repository changes, or maintaining project documentation.
---
# From repository to maintained documentation
DocuWriter's main workflow takes a team from source code to a maintained, searchable documentation system:
1. **Connect the code.** Authorize a GitHub, GitLab, Bitbucket, or Azure DevOps connection, then choose the repository, branch, and source paths to document.
2. **Generate with Full Tree Documentation.** DocuWriter analyzes the selected source and proposes a documentation tree covering the project's architecture, modules, services, APIs, workflows, and implementation details. The team reviews or edits the tree before generation. DocuWriter then creates connected pages that explain related components in context.
3. **Work in Spaces.** The generated pages live in a navigable Space. Engineers can search and ask questions across the documentation, edit or add their own knowledge, collaborate, and share or publish the result. A Space can bring documentation from multiple repositories together.
4. **Maintain what changed.** Autopilot examines changes in connected repositories, identifies pages they may affect, and drafts targeted updates. Engineers can review, refine, accept, or reject the suggestions. Controlled automatic application is available for configured workflows.
The team should review generated pages before relying on or publishing them. Autopilot requires a connected repository and a configured Space link to respond to later code changes.
## Composer mentions and existing tools
In supported desktop hosts, users can select accessible documents through native composer mentions before asking a question. Native composer mentions are not available on mobile. The host, not the model, invokes the app-only `search-documentation-mentions` tool to match document titles and Space names lexically, returning up to 20 recent documents for an empty query. Distinguish duplicate titles using the Space and selected URI. Read the selected private `docuwriter://spaces/{space_id}/documents/{document_id}` resource through `resources/read` as `text/markdown`; mention lookup and reads have no side effects.
Other supported workflows remain ordinary prompt-based tool requests and do not require a mention. Use the existing generation tools for supplied code and supported repository workflows. Use `search-space-documents` or `global-search` for semantic content search; mention lookup does not replace them. To list pending Autopilot suggestions, discover an accessible Space with `list-spaces` and call `list-space-suggestions` with `status: "pending"`. Report the returned summary and status without promising a full before/after preview. Do not apply, discard, or snooze suggestions unless the user explicitly requests and authorizes the separate write tool. Attaching a mention never authorizes a write.
## Review repository changes on demand
When the user wants existing documentation checked against repository changes, use `inspect-documentation-update` before starting paid work. Infer the task from its meaning, not a particular phrase. Resolve the numeric Space ID with authorized discovery (`list-spaces`); ask for clarification when the Space or intent is ambiguous. A selected document or current browser page does not grant management permission.
Inspection reads provider state but queues no work, reserves no credits and invokes no models. Explain Space, repository branch, baseline and target commit, mode, affected or selected pages and rationale, maximum credits and available credits. Preserve any earlier named-page scope by resolving its actual page IDs. Page selection is supported only for first/full reviews; do not submit a partial selection for a diff review or silently broaden it. Omitting selection inPreview of the first 4,000 characters. Read full instructions →
docuwriter-official-docs3.37 KB
View saved version →
---
name: docuwriter-official-docs
description: Finds and cites published DocuWriter Platform Docs for product how-to, setup, and platform feature questions, including Full Tree Documentation, Spaces, and Autopilot.
---
# Find official DocuWriter instructions
Use this skill for product how-to, setup, or platform feature questions. Use the read-only MCP tool `search-docuwriter-platform-docs` to search first-party published DocuWriter Platform Docs, then cite the canonical URLs returned with its excerpts. It searches the official documentation, including its API reference; it does not search customer Spaces or change content. For customer-authored documentation, use `search-space-documents` within one Space or `global-search` across accessible Spaces instead.
Identify the task, open the matching guide, and cite the specific guide URL in the answer. Check the live guide before giving version-sensitive steps or claiming a capability is available. Browser-only actions still require the DocuWriter browser UI; do not claim a search completed them.
| Task | Official starting point |
| --- | --- |
| Generate a structured, multi-page Space for an entire project with Full Tree Documentation | [Full Tree Documentation guide](https://docs.docuwriter.ai/docuwriterai-platform-docs/generate-documentation/generate-complete-codebase-documentation) |
| Organize documentation in Spaces | [Spaces overview](https://docs.docuwriter.ai/docuwriterai-platform-docs/manage-and-share-spaces/organize-pages-and-folders) |
| Maintain documentation and notifications | [Autopilot overview](https://docs.docuwriter.ai/docuwriterai-platform-docs/keep-documentation-current/how-autopilot-keeps-documentation-current), [setup guide](https://docs.docuwriter.ai/docuwriterai-platform-docs/keep-documentation-current/connect-a-space-to-autopilot), and [notifications](https://docs.docuwriter.ai/docuwriterai-platform-docs/keep-documentation-current/configure-autopilot-notifications) |
For a setup step not covered by these guides, search the [official documentation](https://docs.docuwriter.ai/) for the relevant page. If a guide is unavailable or does not answer the question, say what remains unverified rather than inventing instructions.
## Composer mentions and product guides
In supported desktop hosts, native composer mentions let users select customer documents before asking a question; they do not select official product guides. Native composer mentions are not available on mobile. The host, not the model, invokes the app-only `search-documentation-mentions` tool for lexical lookup by document title or Space name, returning up to 20 recent documents for an empty query. Use Space context to distinguish duplicate titles and read the selected private `docuwriter://spaces/{space_id}/documents/{document_id}` resource through `resources/read` as `text/markdown`. Lookup and reads have no side effects and remain account-authorized.
Official-guide search and other supported tools remain ordinary prompt-based workflows and do not require a mention. For official setup instructions, continue to use `search-docuwriter-platform-docs` and cite its canonical guide URLs. For semantic customer-content questions without a selected mention, continue to use `search-space-documents` or `global-search`. Any requested write requires its separate MCP tool after an explicit request and authorization; a mention or guide search does not authorize it.
docuwriter-overview3.07 KB
View saved version →
---
name: docuwriter-overview
description: Explains DocuWriter's Full Tree Documentation, Spaces, repository documentation reviews, and Autopilot. Use for product introductions and capability overviews.
---
# DocuWriter
DocuWriter helps teams generate, manage, and maintain documentation for their software projects. Its core workflow combines Full Tree Documentation, Spaces, and Autopilot.
## What the team gets
Full Tree Documentation analyzes the selected repository source, proposes an outline for the team to review, then generates a connected set of pages about the project. The pages explain architecture, modules, services, APIs, workflows, and implementation details in context. For example, an API is explained alongside the service that owns it. The result is a navigable documentation tree in a Space.
Spaces give teams one place to browse, search, edit, organize, share, and publish those pages, including knowledge added by engineers. A Space can bring documentation from multiple repositories together.
Autopilot watches changes in connected repositories, identifies documentation that may be affected, and drafts focused updates for review. Teams can accept, refine, or reject suggestions, or configure controlled automatic application where appropriate.
## Repository documentation reviews
For an existing repository-backed Space, `inspect-documentation-update` shows eligible page scope, repository changes and maximum credits without starting work. After the user explicitly approves that scope and maximum cost, `start-documentation-update` starts the quoted paid review. `get-documentation-update-status` returns persisted progress, costs and the browser review link. A quote or attached document is not authorization to spend credits. Applying or rejecting changes, approving new pages, resuming and ending remain browser actions. Use the documentation lifecycle skill for exact scope and consent rules. This workflow differs from editorial edits, new generation and Autopilot configuration.
## Composer mentions
In supported desktop hosts, users can select an accessible document through native composer mentions before asking a question grounded in its content. Native composer mentions are not available on mobile. The host, not the model, invokes the app-only `search-documentation-mentions` tool for lexical lookup by document title or Space name; an empty query returns up to 20 recent documents. Distinguish duplicate titles by their Space context and use the selected resource URI, not a guessed ID.
The selected private resource is `docuwriter://spaces/{space_id}/documents/{document_id}` and is read through `resources/read` as `text/markdown` under the connected account's permissions. Mention lookup and reads have no side effects and do not authorize edits or publication. Existing generation, semantic search, suggestion listing, and official-guide workflows remain ordinary prompt-based tool requests and do not require a mention. Use `search-space-documents` or `global-search` for semantic search. Any requested write must use its separate MCP tool after an explicit request and authorization.
