基础指南

知识库治理与文档标准

区分大纲、概念指南和操作手册,维护内容状态与证据。

更新于
复用与演进 / 数据与知识定位整体框架 ↗
复用与演进 × 数据与知识:当前工作是治理文档与知识资产,产出负责人、版本与复审;显示相关阶段和相邻领域
本页目录

按内容类型约定结构

  • 待完善大纲(outline):学习目标、计划章节、预期交付物与建设清单。
  • 基础指南(guide):适用场景、概念或方法、判断依据、限制与相关资料。
  • 操作手册(playbook):适用版本、前置条件、步骤、验证方法、失败回退、风险和审核证据。

不能把仅有概念或计划的内容标成操作手册。首页和搜索结果必须展示内容状态;状态变更需随内容更新一起审核。

文档元数据

每篇文档包含下述仓库已实现的元数据;生产操作内容还应记录适用版本、责任人和审核证据。

发布流程

建议流程:作者提交文档 → 执行类型、链接与构建检查 → 查看页面 → 技术与内容审核 → 合并或提交主分支 → 检查实际托管结果。具体部署取决于仓库配置。

生命周期

  • 草稿:尚不能指导现场执行。
  • 审核中:等待技术和内容确认。
  • 已发布:当前有效版本。
  • 待复审:临近复审期限或依赖发生变化。
  • 已归档:保留历史但不进入默认搜索。

质量指标

搜索无结果率、文档使用率、问题解决率、过期率、反馈关闭时间和重复问题数量。访问量高不等于内容有效,应结合任务是否完成判断。

AI 索引要求

标题直接表达问题,段落有清晰语义边界,结论附带条件和来源,版本信息进入元数据,删除内容时同步清除旧索引。

本仓库的实际字段与发布边界

当前已实现的元数据为 title、description、slug、category、order、updatedAt、status、tags、aiIndex、searchIndex。作者、负责人、审核人与适用版本应在需要时写入正文或项目审核记录;不能声称程序已经强制校验了未实现字段。

目前 46 篇文章均为基础指南,包含教学示例与练习;没有标记为经过客户现场验证的操作手册。GitHub 同步确认的是仓库提交,线上托管是否成功需要另查部署结果,不能由 push 成功推断。

内容维护责任与节奏

类型复审触发应核查
模型与框架API、条款或版本变化示例与能力边界
安全与权限新工具、数据源或攻击面反例、撤权与审计
架构与集成契约或数据模型变化兼容性与恢复
教学与案例练习反馈和新证据可复现性与标注

建议每月处理失效链接与反馈,每季度审查全局架构;这是维护建议,不表示已经设置自动定时任务或指定真实负责人。

图片和资料来源

所有配图均为本站制作的 SVG 示意图,图内统一标注“来源:fde.loyo.work”,统一清单见图片来源记录。它们不是外部照片、真实界面截图或 image 模型生成图。外部文档作为参考链接保留其原有权利,不转载原文或图片。

质量门禁

构建检查 MDX、类型、内容链接、静态页面、配图存在与来源、模板与练习文件。自动检查不能替代事实审核;新结论仍需明确来源、条件与证据。

知识框架使用 content/framework.json 维护阶段、能力、工作、前置与产出。新增文章必须明确映射;局部图由全局框架裁取,不由章节标题生成。

参考阅读与使用边界

本页为基础指南;生产操作需结合实际版本、授权环境与审核证据验证。

Markdown 原文反馈本页问题 ↗