cratis-llm-friendly-documentation
Use when designing or reviewing llms.txt, Markdown mirrors, bounded documentation exports or retrieval quality. Not for general SEO metadata or a page's human-facing narrative.
原文 · 译文尚未补齐适用对象:AI 与流程自动化。自动收录 · 待核查。
原作者说明节选
从固定版本的 SKILL.md 提取,保留原文语言。以下内容属于作者说明,本站尚未验证安装、兼容或运行结果。
查看英文原文
原文涵盖的主题
- Documentation that an assistant can retrieve and cite
- Start with the existing publishing system
- Keep discovery aligned with the reader journey
- Design progressive retrieval
- Verify retrieval, not merely file existence
A giant text file is downloadable, but it is rarely the right context for one question. Help an assistant choose the relevant product, supported version and workflow, then retrieve a small, complete explanation. Keep human documentation canonical: generate alternate representations from the same source and build, not a separately authored AI manual. Inspect the source map, routes, renderer, content collection, existing indexes, page actions, and build/deploy hooks. A synchronized .mdx source can still contain imports, JSX, hidden tab alternatives, and component-only meaning; renaming or copying it to .md does not make it clean rendered Markdown. Inspect actual output before calling it LLM-friendly. A routing index and a full-text export serve different retrieval needs. Neither proves crawler adoption, answer quality, or that an entire product will fit a model's context window. Follow the documentation rule for Platform naming and product claims: route an umbrella query to the relevant component, without implying that a single-component task needs every product. A root index should expose that first useful path; product and task indexes should continue it with enough context to iden
这里只展示节选,请以完整原文和当前要求为准。
- 来源仓库
- Cratis/AI
- 源文件
- .cratis/ai/skills/cratis-llm-friendly-documentation/SKILL.md
- 固定版本
- 868bc20e7f474299466331a3cf86eaf995be0a2b
准备条件
- 本条仅收录原作者的技能元数据;请阅读完整说明,确认依赖、许可与使用条件。
第一件可以尝试的小事
先阅读原作者说明,再决定是否在自己的 AI 工具中使用。
对应 AI 工具说明
作者有说明不等于本站实机验证。没有证据时,不自动标为兼容、安全或免费。
来源与内容状态
本条为自动发现的元数据,尚未完成人工文档核查;适用性与运行结果待核查。
原作者:Cratis/AI · 原作者仓库元数据。文档核查:未核查。最近来源检查:2026-11-12T11:00:49.582Z。
分类由名称、说明与路径规则生成,分类不代表已核实适配。
许可与权利归属
MIT。第三方内容及版权归原作者,使用条件以原文为准。
许可原文 ↗本站没有因同步、复制或用户自报成功而将资源标为运行验证通过。
限制与注意事项
- 元数据收录不代表本站已经安装、适配、实测或进行安全审查。