技术文档工程

共 19 题
#

1. Docs-as-Code 的实践中技术文档与代码同仓、同 PR、同 CI 的工作流如何设计?

A 文档与代码同仓、同 PR、同 CI,经过 lint 与死链检查后随代码一起发布 ✓ 正确答案
B 文档应单独存放,与代码无关
C 文档不需要评审,直接发布即可
D Docs-as-Code 只适用于单一语言的纯文本项目
#

2. 文档的四象限模型(Diátaxis)中 Tutorial、How-to Guide、Reference、Explanation 各自的写作目标和结构?

A Tutorial 面向有经验的用户,讲解复杂原理
B 四类文档可以混写成一种通用格式
C Reference 文档应详细解释设计原因
D Tutorial 教初学者完成任务,How-to 解决具体问题,Reference 描述事实,Explanation 阐述概念 ✓ 正确答案
#

3. API 文档的自动化生成与人工补充中 OpenAPI/Swagger 生成的文档质量如何保障?

A 完全依赖自动生成即可,无需人工补充
B 手工维护 API 文档,不依赖规范
C 以 OpenAPI 为契约源自动生成骨架,人工补充语义与示例,并用 CI 校验与实现一致性 ✓ 正确答案
D 自动生成后无法人工补充内容
#

4. 文档的单一来源中同一信息多处重复导致的漂移如何用引用、include 与自动生成消除?

A 同一信息在多个文档中重复更安全
B 手工复制粘贴是保证一致性的最佳方式
C 通过 include、引用与自动生成,让同一事实仅在一处权威定义并处处引用,消除漂移 ✓ 正确答案
D 单一来源只适用于代码文档,不适用于业务文档
#

5. 文档的持续维护中如何检测文档与代码的漂移?CI 中的文档检查(死链、过时截图、代码示例可运行)?

A 通过 CI 自动化检查死链、格式、可运行示例,并同仓 PR 关联来检测与代码的漂移 ✓ 正确答案
B 代码示例不需要验证可运行性
C 文档只需人工偶尔检查即可
D 死链不影响文档质量
#

6. 内部文档的搜索与发现中如何设计文档的信息架构使新人能快速找到所需信息?

A 信息架构只影响美观,不影响可用性
B 按部门组织结构组织文档最方便
C 文档越多越好,无需分类
D 按读者角色与任务类型组织,提供清晰导航、多入口与强搜索,降低检索成本 ✓ 正确答案
#

7. 文档的国际化与多语言维护中如何避免翻译版本与源版本的漂移?

A 每个语言版本独立维护,互不关联
B 机器翻译无需人工审核即可发布
C 以源语言为单一权威,源变更时标记翻译过期并同步更新,避免漂移 ✓ 正确答案
D 翻译版本间无需保持版本一致
#

8. 如何让文档"活"起来,文档与代码的关联、过期文档的自动检测机制?

A 文档写完后无需再管
B 过期文档无法检测,只能人工逐篇看
C 通过文档与代码同仓关联、自动生成、核验日期与 CI 检查实现同步与过期检测 ✓ 正确答案
D 文档与代码应完全独立,减少耦合
#

9. API 文档、架构文档、运维文档的读者与维护责任如何划分?

A 所有文档都由一个文档团队统一维护
B 文档无需指定负责人
C API 文档归接口维护团队、架构文档归架构师、运维文档归运维团队,并建立文档所有者机制 ✓ 正确答案
D 读者是谁不影响文档责任划分
#

10. 文档的分层中用户文档、API 文档与内部文档?

A 用户文档、API 文档、内部文档按读者分层,各自内容与渠道独立 ✓ 正确答案
B 内部文档应公开给最终用户
C 所有文档应面向所有读者,统一风格
D 用户文档应包含全部实现细节
#

11. 文档的版本化中文档随代码版本发布与历史版本浏览如何设计,主版本分支与最新导航如何组织?

A 文档始终只展示最新内容,不保留历史
B 文档随代码版本打标签发布,文档站点支持版本切换并标注 EOL,最新导航指向当前稳定版 ✓ 正确答案
C 所有版本共用一套文档即可
D 历史版本文档不需要保留
#

12. 文档的度量中如何评估文档的质量(用户满意度、支持工单减少率)?

A 只需看文档写作是否流畅
B 结合用户满意度、支持工单减少率、文档命中率与维护质量等多指标评估,并建立改进闭环 ✓ 正确答案
C 文档质量无法度量,无需评估
D 工单减少率完全归因于文档即可
#

13. AI 辅助文档生成中 LLM 生成文档的可用性和人工审核流程?

A AI 生成文档无法保证准确性,应完全禁用
B LLM 生成的文档可直接发布,无需审核
C LLM 生成初稿并以真实来源约束,人工对照代码审核事实准确性,再经 CI 校验发布 ✓ 正确答案
D 人工审核只需看文笔是否通顺
#

14. 如何用文档即代码(Docs as Code)的流水线保证文档质量与发布节奏?

A 文档发布依靠人工每周手工操作
B 通过 CI 自动化检查、门禁与自动构建发布,实现文档的持续交付与质量保障 ✓ 正确答案
C 文档不需要 CI 检查
D 文档发布与代码发布完全无关
#

15. 文档的维护中自动化生成与同步?

A 全部文档都应由人工手工编写
B 从代码/规范自动生成 API、配置、changelog 等文档,并用 CI 校验与同步,人工只负责语义内容 ✓ 正确答案
C 自动化生成后无需再校验
D 自动生成会导致文档与代码脱节
#

16. 文档的质量中清晰、准确与可搜索?

A 只要文笔流畅即可,无需考虑准确性
B 文档质量无法检查,只能靠作者自觉
C 三者的优先级是搜索 > 准确 > 清晰
D 准确靠真实来源与示例验证,清晰靠结构与措辞,可搜索靠标题与索引,三者需工程手段保障 ✓ 正确答案
#

17. 技术文档的评审与协作中文档评审与代码评审的差异,如何用文档即代码(Docs as Code)的流程保证多人协作下文档质量?

A 文档评审与代码评审完全一样,无需区别
B 文档评审不需要读者参与
C 文档评审侧重准确与清晰并引入读者视角,用 lint/术语表等自动化门禁配合 Docs-as-Code 同 PR 流程保障协作质量 ✓ 正确答案
D 文档评审无法借助自动化工具
#

18. 文档即代码中 Markdown、lint 与 CI?

A CI 只负责代码,不处理文档
B lint 可有可无,不影响文档质量
C Markdown 无法进行版本控制
D Markdown 是载体,lint 提供客观质量检查,CI 串联构建发布与门禁,三者配合实现文档工程化 ✓ 正确答案
#

19. 文档的贡献激励中模板、示例与低门槛评审如何提升工程师写文档的参与度?

A 通过强制要求就能提升参与度
B 用模板与示例降低成本、低门槛评审降低阻力、与 PR 绑定并认可贡献,综合提升参与度 ✓ 正确答案
C 文档写得好不好无所谓,只要写了即可
D 只有文档团队能写文档