新人エンジニアが入っているプロジェクトにおけるREADMEの書き方について解説をしています。
エンジニアが開発しやすい環境作りをする(Zenn)
(新人)エンジニアが開発しやすいREADMEの書き方KNR
View Slide
KNR300
目次自己紹介前提READMEがしっかり書かれていない..READMEの書き方1.2.3.4.
自己紹介前提READMEがしっかり書かれていない..READMEの書き方1.2.3.4.
KNR (25)2021年にWeb系の開発会社に新卒入社 (3年目)執行役員2022年 Qiita TOP Contributor自己紹介
自己紹介前提READMEがしっかり書かれていない..READMEの書き方
紹介する内容が必ずしも正解というわけではありません歴0~1年目の新人エンジニアがいるプロジェクトにいる想定前提
READMEがしっかり書かれていない..
自己紹介前提READMEがしっかり書かれてない..READMEの書き方
プロジェクトに参加した新人や新規参加者が「READMEを読めば開発に関する概要が得られる」ようなドキュメントを目標に作成するREADMEの目標
目次外部ドキュメントのリンクシステム構成の概要使用技術について環境構築の手順ディレクトリ構造Gitの運用ルール参考記事1.2.3.4.5.6.7.8.READMEの内容
目次1.
2. 外部ドキュメント
3. システム構成の概要
4. 使用技術について
5. 環境構築の手順
6. ディレクトリ構造
7. Git 運用ルール
8. 参考記事
まとめ目次外部ドキュメントシステム構成の概要使用技術環境構築の手順ディレクトリ構造Gitの運用ルール参考記事1.2.3.4.5.6.7.8.https://zenn.dev/sutamac/articles/5a262f0096176a発表した内容の詳しい記事です👇
ご清聴ありがとうございました