このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- フォリオ
- テクニカル ライター:
- gallinita
- プロジェクト名:
- FOLIO アプリのエンドユーザー ドキュメントの拡大
- プロジェクトの期間:
- 長時間（5 か月）
プロジェクトの説明
このプロジェクトでは、エンドユーザーを対象とする FOLIO のドキュメントの作成と更新に取り組んでいきます。FOLIO は図書館管理システムであるため、エンドユーザーは図書館の職員です。現在、FOLIO Wiki（https://wiki.folio.org/）にはいくつかのドキュメントが含まれていますが、これは最小限のものであり、図書館のスタッフを念頭に置いて作成された理解しやすい形式ではありません。このプロジェクトから作成された新しいドキュメントは、特定のドキュメントのナレッジベースでホストされます。このナレッジベースには、FOLIO のアプリからアクセスでき、システムとそのライブラリ ユーザーに関連するワークフローが含まれます。サイトには、資料の配布とコース予約の機能に関する一連のドキュメントが最初に公開されます。この「長期にわたる」プロジェクトの間、できる限りドキュメントに貢献したいと思います。
FOLIO のドキュメント プロジェクトについて、Marcia Borensztajn 氏に FOLIO のニーズと現在のドキュメントの状況についてお話を伺いました。前述のとおり、FOLIO のユーザーを適切にサポートするには、FOLIO のドキュメントの更新、拡張、修正が必要です。標準ライブラリのプロセスをミラーリングするためにドキュメントを作成する必要があります。FOLIO は連携するさまざまな「アプリ」で構成されているため、システム全体を説明する必要があります。私は図書館員ですので、FOLIO のユーザーが直面し、サポートが必要になるようなシナリオやワークフローには精通しています。Marcia は、Markdown、Git、Hugo を使用して、新しいドキュメント ナレッジベースの作成に取り組んでいます。このプロジェクトから、FOLIO に関する新しいドキュメントが作成され、将来のフレームワークとして機能します。