本页面包含 Google 文档季接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- FOLIO
- 技术文档工程师：
- gallinita
- 项目名称：
- 扩展了 FOLIO 应用的最终用户文档
- 项目时长：
- 长期（5 个月）
Project description
在本项目中，我计划负责创建和更新面向最终用户的 FOLIO 文档。由于 FOLIO 是一个图书馆管理系统，因此最终用户是图书馆工作人员。目前，FOLIO Wiki (https://wiki.folio.org/) 包含一些文档，但数量很少，而且文档的格式不易于理解，没有考虑到图书馆工作人员的需求。通过此项目创建的新文档将托管在特定文档知识库上，该知识库可通过 FOLIO 的应用访问，并且包含与系统及其库用户相关的工作流。我们最初将在网站上发布一套文档，首先是传播和课程预留功能。在这个“长期”项目过程中，我希望为文档提供尽可能多的帮助。
在研究 FOLIO 文档项目时，我与 Marcia Borensztajn 讨论了 FOLIO 的需求和当前文档情况。如上所述，FOLIO 文档需要更新、扩展和重做，才能成功帮助用户。需要创建文档来反映标准库流程，并且由于 FOLIO 由协同工作的不同“应用”组成，因此需要对整个系统进行说明。我本人是一名图书管理员，非常熟悉 FOLIO 用户可能会遇到的情况和工作流程，以及他们可能需要的帮助。Marcia 正在努力使用 Markdown、Git 和 Hugo 创建新的文档知识库。在此项目中，我们将创建有关 FOLIO 的新文档，并将其用作未来的框架。