このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- FOLIO
- テクニカル ライター:
- gallinita
- プロジェクト名:
- FOLIO アプリのエンドユーザー向けドキュメントの拡充
- プロジェクト期間:
- 長期実行（5 か月）
プロジェクトの説明
このプロジェクトでは、エンドユーザーを対象とした FOLIO ドキュメントの作成と更新に取り組む予定です。FOLIO は図書館管理システムであるため、エンドユーザーは図書館スタッフです。現在、FOLIO ウィキ（https://wiki.folio.org/）にはドキュメントがいくつかありますが、内容は最小限で、図書館スタッフを念頭に作成された消化しやすい形式ではありません。このプロジェクトで作成された新しいドキュメントは、特定のドキュメント ナレッジベースでホストされます。このナレッジベースには、システムとそのライブラリのユーザーに関連するワークフローが含まれており、FOLIO のアプリからアクセスできます。最初の一連のドキュメントがサイトに公開されます。最初は、図書館の貸出とコースの予約機能に関するドキュメントが公開されます。この「長期にわたる」プロジェクトの期間中、ドキュメントの作成にできる限り貢献したいと思います。
FOLIO ドキュメント プロジェクトについて調査するため、FOLIO のニーズと現在のドキュメントの状況について、Marcia Borensztajn にインタビューしました。前述のとおり、FOLIO のユーザーの皆様をサポートするには、FOLIO のドキュメントを更新、拡張、修正する必要があります。標準のライブラリ プロセスを反映したドキュメントを作成する必要があります。また、FOLIO は連携するさまざまな「アプリ」で構成されているため、システム全体を説明する必要があります。私は図書館員なので、FOLIO のユーザーが直面するであろうシナリオやワークフローの種類に精通しており、サポートを必要としています。Marcia は、Markdown、Git、Hugo を使用して新しいドキュメント ナレッジベースの作成に取り組んでいます。このプロジェクトから、FOLIO に関する新しいドキュメントが作成され、今後のフレームワークとして機能します。