AGENT SKILL

write-document

Create or edit Markdown documents inside a Design Studio prototype. Use only when Documents is enabled; shared system context and Manual chapters have separate owners.

License 许可
MIT
最近更新
2026-11-14
Stars
★ 161
Forks
25

01 前言 Front Matter

name
write-document
description
Create or edit Markdown documents inside a Design Studio prototype. Use only when Documents is enabled; shared system context and Manual chapters have separate owners.

03 SKILL.md 正文

Write Document

This skill applies to prototype Markdown when Documents is enabled. Format and rendering are described in the module README.

  • Write prototype-specific context in a .md file outside underscore helpers. No registration is required.
  • Use plain Markdown. Do not add JSX or embedded components.
  • Use fenced mermaid code blocks for diagrams. Include accTitle and accDescr for accessible descriptions. The platform renders the diagram from its text; no image file is needed.
  • Give the page a frontmatter title or an opening level-one heading.
  • Link to prototype artifacts with relative paths. Include file extensions for links intended to work in ordinary Markdown readers.
  • Studio links accept omitted extensions, but other readers may not resolve them.
  • Embed a file from the same prototype using Markdown image syntax on its own line: ![Description](./flow.mermaid), ![Screen](./app/main.tsx), or ![Exploration](./breadboard.excalidraw). The corresponding module must be enabled. Use relative paths with extensions.
  • File embeds show read-only previews and an Open link; files without previews, including documents, show cards. Canvas previews keep documents and other canvases as cards to bound nesting.
  • Reference the original file instead of copying diagram source or screen code into the document. Ordinary image files remain outside the prototype document convention.
  • Put shared product context in the system context instead.

Write the file directly for the person. The local app discovers it and reflects edits.

For new directly authored artifacts, preview and apply identity assignment. Preserve existing identity metadata when editing.

Verify

Inspect the rendered artifact, its links, and any embeds. Repair reported rendering errors and follow platform working context for required checks. Report the artifact link and unresolved content.

04 同仓库更多 Skills