残して良かったドキュメント、いまいちだったドキュメント - Qiitaこの記事の概要 エンジニア的な文化・行動として「ドキュメントを残そう」をよく聞きますよね。 私の在籍するQiita株式会社では、社内の情報共有もかなり強く意識しています。 普段からドキュメントを残している中で、どんなものが効果的だったかを記事にしてみました。 なお、ここでいうドキュメントとはコード内のコメントやREADMEではなく社内Wikiのようなものを指しています。 定期的に人に説明する内容 入社時にやること 今導入している技術やサービスのまとめ 制度上のフローやガイドラインなど 新しく入社した人に説明する内容や、チーム間で異動があったら共有すべき内容などのイメージ。 自分は「この内容、何度か人に説明してるなあ」と気付いたらドキュメント化するよう心がけています。 また、これらがしっかり残っていると、次の「新しく何かを始める際の記録」が取りやすくなります。 新しく何かを始める際の記録 技
