Upgrade to Pro — share decks privately, control downloads, hide ads and more …

(新人)エンジニアが開発しやすいREADMEの書き方

KNR
June 27, 2023

 (新人)エンジニアが開発しやすいREADMEの書き方

新人エンジニアが入っているプロジェクトにおけるREADMEの書き方について解説をしています。

エンジニアが開発しやすい環境作りをする(Zenn)

KNR

June 27, 2023
Tweet

More Decks by KNR

Other Decks in Technology

Transcript

  1. (新人)エンジニアが開発しやすい
    READMEの書き方
    KNR

    View Slide

  2. KNR
    300

    View Slide

  3. 目次
    自己紹介
    前提
    READMEがしっかり書かれていない..
    READMEの書き方
    1.
    2.
    3.
    4.

    View Slide

  4. 自己紹介
    前提
    READMEがしっかり書かれていない..
    READMEの書き方
    1.
    2.
    3.
    4.

    View Slide

  5. KNR (25)
    2021年にWeb系の開発会社に新卒入社 (3年目)
    執行役員
    2022年 Qiita TOP Contributor
    自己紹介

    View Slide

  6. 自己紹介
    前提
    READMEがしっかり書かれていない..
    READMEの書き方

    View Slide

  7. 紹介する内容が必ずしも正解というわけではありません
    歴0~1年目の新人エンジニアがいるプロジェクトにいる想定
    前提

    View Slide

  8. 自己紹介
    前提
    READMEがしっかり書かれていない..
    READMEの書き方

    View Slide

  9. READMEがしっかり書かれていない..

    View Slide

  10. 自己紹介
    前提
    READMEがしっかり書かれてない..
    READMEの書き方

    View Slide

  11. プロジェクトに参加した新人や新規参加者が「READMEを読めば開発に関する概
    要が得られる」ようなドキュメントを目標に作成する
    READMEの目標

    View Slide

  12. 目次
    外部ドキュメントのリンク
    システム構成の概要
    使用技術について
    環境構築の手順
    ディレクトリ構造
    Gitの運用ルール
    参考記事
    1.
    2.
    3.
    4.
    5.
    6.
    7.
    8.
    READMEの内容

    View Slide

  13. 目次
    1.

    View Slide

  14. 2. 外部ドキュメント

    View Slide

  15. 3. システム構成の概要

    View Slide

  16. 4. 使用技術について

    View Slide

  17. 5. 環境構築の手順

    View Slide

  18. 6. ディレクトリ構造

    View Slide

  19. 7. Git 運用ルール

    View Slide

  20. 8. 参考記事

    View Slide

  21. まとめ
    目次
    外部ドキュメント
    システム構成の概要
    使用技術
    環境構築の手順
    ディレクトリ構造
    Gitの運用ルール
    参考記事
    1.
    2.
    3.
    4.
    5.
    6.
    7.
    8.
    https://zenn.dev/sutamac/articles/5a262f0096176a
    発表した内容の詳しい記事です👇

    View Slide

  22. ご清聴ありがとうございました

    View Slide