ハンドブックを編集する

ハンドブックとは

フルリモートであるAltive株式会社において、ドキュメントはとても大事です。 ハンドブックを「信頼できる唯一の情報源」として、日々メンテナンスしてく必要があります。

ハンドブックを編集する

ハンドブックやドキュメントは時間と共に古く劣化していきます。

特に「オンボーディング」のページは、実際に活用するのが入社直後のみということもあり必要な変化に既存社員が気が付きにくいです。

「ここが間違っている、古くなっている、足りない」や「こう書いたらもう少し分かりやすいかも？」のような改善点に気が付きやすいのは、実際にオンボーディングを行なっているあなたです。

どんなに小さいところでも良いので編集してみましょう。

ハンドブックを編集する手順

1. The Altive Handbook repositoryにアクセスします。
2. 任意の方法でリポジトリをCloneします。
3. VS Codeなどの自身の使用しているIDEで編集を行います。
4. 編集が完了したら、READMEに記載されている内容を実行してローカルでサーバーを立ち上げ、変更内容を確認します。
5. プルリクエストを出します。
6. 他の社員からレビューをもらい、Approve(承認)がもらえたら、自身でmainブランチにマージします。
7. マージ後はGitHub Actionsのデプロイワークフローが実行され、更新が反映されます。