指南概览
指南概览
指南是面向中高级用户的"如何把 X 做好"内容。请选择与您目标匹配的分组。大多数读者从 写作质量 开始 —— 这一组对每一个 docmd 站点都适用,与您使用的技术栈或关注的特性无关。
写作质量
面向每一位 docmd 用户。涵盖可扩展的技术写作、可读性、任务型 vs. 概念型文档,以及如何避开反模式。最普适的分组。
从写作质量开始 →
工作流与团队
面向文档负责人与团队。基于 Git 的工作流、预览环境、大规模协作的一致性、发布工作流。
探索工作流与团队 →
搜索
面向所有拥有搜索框的站点。提升相关性、优化速度、Local-First 索引、加入语义搜索。
优化您的搜索 →
性能
关心 Time to Interactive 的团队。100ms 以内的导航、CDN 部署、JS 载荷缩减、低端设备、缓存策略。
让站点更快 →
AI 与 LLM
希望文档能被 AI Agent 与 LLM 阅读的团队。MCP、Agent Skills、llms.txt、语义搜索设计、分块、上下文保留。
让文档对 AI 友好 →
集成
把 docmd 与您的其他技术栈对接。OpenAPI 生成、GitHub Actions、接入既有 Markdown 仓库、并行使用其他工具。
查看集成 →
不确定从哪里开始?
如果 docmd 是您的新朋友,请先跳过指南,读一遍 快速开始。指南默认您已经熟悉了基础内容。