Documentation
“Documentation” 是名词,通常指“文档、资料说明”。在软件开发中,它既包括用户文档,也包括 API、架构和运维文档。
- “Clear documentation reduced onboarding time for new engineers.” (清晰的文档缩短了新工程师的上手时间。)
- “Please read the API documentation before integration.” (集成前请先阅读 API 文档。)
- “Good documentation makes maintenance much easier.” (好的文档会让后续维护轻松很多。)
来自动词 “document”(记录、证明),其词根与“教导、展示证据”相关,强调可追溯信息。
后缀 “-ation” 将动词转为名词,表示过程或结果,“documentation” 即“文档化的过程/产物”。
在工程文化里,“documentation” 被视为团队协作基础,尤其在跨团队沟通、开源项目和长期维护中价值很高。
- 固定搭配: “technical documentation” (技术文档), “project documentation” (项目文档)
- 相关词: “document” (文档/记录), “documented” (有文档记录的)
记住 “doc” 常与文档相关,documentation 就是“完整、系统的说明资料”。
“When the original developer left, detailed documentation saved the entire project.” (原开发者离开后,详尽文档拯救了整个项目。)