このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- Open Source Geospatial Foundation
- テクニカル ライター:
- flicstar
- プロジェクト名:
- OSGeoLive クイックスタートを確認する
- プロジェクトの期間:
- 標準の期間(3 か月)
プロジェクトの説明
目的
- ドキュメントを更新して、最新かつ正確で関連性のあるものにしてください。
- ドキュメント間の一貫性を確保するためのテンプレートを作成します。また、今後追加される新しいクイックスタート用にテンプレートを作成します。
対象
- OSGeo Live の新規ユーザー
- 新しい OSGeo Live クイックスタートのライター
提供
- Wiki
必要な対処:
- 既存の 50 の OSGeo Live クイックスタートを実施する
- 編集をマークアップします。審査に送信
- レビュー/フィードバックを実装する
- クイックスタート テンプレートを作成して、今後に向けた一貫性を実装します。
- 「クイック スタート手順を行う方法」を更新しました。
- OSGeoLive に新しいアプリを追加する - クイックスタートが必要である。
推奨事項:
既存の OSGeo Live クイックスタート ガイド 50 件を確認し、編集を加えたマークアップを行います。以下のページを参考にしてください。
新規: https://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20the%20quickstart%20file
旧: https://wiki.osgeo.org/wiki/OSGeoLive_AddProject#Documentation
trac にドキュメントの問題を作成する(Issue Tracker)
結果をまとめたレポートを提供します。たとえば、50 のうち、最小限の作業、中程度の作業、または大量の作業を必要とする開発者の割合です。
クイックスタート テンプレートを作成して、今後に向けた一貫性を実装します。
「How to document the Quickstart file」ページを更新します。
SoD の最後に表示される内容:
- 合意済みのクイックスタート テンプレートに従ってクイックスタートをマークアップした 50 個のドキュメント チケット(トラック内)
- OSGeo Live クイックスタートの現在のステータスと、更新に必要な作業量のスナップショット。
- トレーニング ガイド テンプレートと一致する更新済みのクイックスタート テンプレート。
- クイックスタート ドキュメント プロセスの更新。
はじめに
- OSGeo-Live Packages スプレッドシートで、リリース間で変更されたパッケージを確認します。
- OSGEo Live のメーリング リストに、開始するための具体的なクイックスタートについて提案があるかどうかを確認します。
すでに行ったこと:
- VM をセットアップして OSGeoLive をインストールする
- OSGeoLive-Doc リポジトリをフォークしました
- trac にアクセスし、既存のドキュメント チケットを確認。チケット #1382 は関連性がありそう: https://trac.osgeo.org/osgeolive/ticket/1382
- メーリング リスト ディスカッションに参加した
- カジュアルなビデオチャットを数回行った