Tweet
Tweet

Slide 1

Slide 1 text

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

Slide 2

Slide 2 text

KNR 300

Slide 3

Slide 3 text

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

Slide 4

Slide 4 text

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

Slide 5

Slide 5 text

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

Slide 6

Slide 6 text

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

Slide 7

Slide 7 text

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

Slide 8

Slide 8 text

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

Slide 9

Slide 9 text

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

Slide 10

Slide 10 text

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

Slide 11

Slide 11 text

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

Slide 12

Slide 12 text

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

Slide 13

Slide 13 text

目次 1.

Slide 14

Slide 14 text

2. 外部ドキュメント

Slide 15

Slide 15 text

3. システム構成の概要

Slide 16

Slide 16 text

4. 使用技術について

Slide 17

Slide 17 text

5. 環境構築の手順

Slide 18

Slide 18 text

6. ディレクトリ構造

Slide 19

Slide 19 text

7. Git 運用ルール

Slide 20

Slide 20 text

8. 参考記事

Slide 21

Slide 21 text

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

Slide 22

Slide 22 text

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