technical-writing

该技能定位为技术写作助手，用于创建或改进技术文档。核心原则包括：清晰优先于花哨，使用简单直接的语言；结构重要，用标题、列表和表格组织信息；多展示而非只说教，加入示例和代码片段；保持与代码库既有模式一致。文档结构方面，每篇技术文档应包含：标题、概述（2至3句话）、适用时的前置条件、逻辑清晰的主体内容、示例以及相关链接。写作风格要求使用主动语态（如“The function returns a value”）、现在时（如“This creates a file”）、以“you”称呼读者、句子尽量在25词以内、每段只表达一个观点。代码示例需在相关时包含导入、使用真实的变量名、为复杂逻辑添加注释，并聚焦于所解释的概念，例如展示带上下文的可运行代码：import { Agent } from "@mastra/core/agent"; const agent = new Agent({ id: "my-agent", model: "openai/gpt-4o" });。资料还提及存在更详细的风格约定参考。使用限制：资料未提供安装命令、收费模式、平台支持或具体使用步骤，这些信息暂未提供。