1
/
5

【勉強会ワーク】「ドキュメントの書き方」編

こんにちは!iXiAの藤原です!

先日12月9日、勉強会にてワークを行いました!

今回はその内容を一部抜粋してご紹介しようと思います!

内容は「設計書(ドキュメント)の書き方」についてです!!

プログラミング経験の浅い僕たちは、開発と聞いて真っ先にイメージするのがコーディングですが、

今回はそういったイメージを払拭するようなワークだったと思います!



今回のワークも、iXiA専属の講師であり現役でエンジニアとして活躍している講師の方に教鞭を振るっていただきながら、実践形式のワークを行いました!

まずは講義の内容です!

・設計とは?

講師:設計とは、簡単にいうとゴール(目標)に到達するための道筋のことで、要するに"計画"です。まずみんなには、身近にある設計にどんなものがあるか考えてみてほしい

早速、身近にある設計の例を挙げていきました!

社員:料理とか?

講師:お、さすがや。他の人はなんか思いついた?

社員:ドライブとかもですか?

講師:そうやね。目的地設定して、そこまでの道のり考えるからそれも合ってる


その後、基本設計や詳細設計、テストやレビューといった、システム開発における一連の流れについて解説いただきました!


社員:質問ですが、システム開発の工程を俯瞰で見ると、実はコーディングに割いてる時間ってそんなに多くないんですか?

講師:そうなんよ。開発って、みんなは手を動かしてコード書いてるイメージの方が強いと思うけど、実は設計段階とか、どういう機能を実装するのか考えたり、話し合う時間とかの方が長かったりするんよ。


講師:ここまで色々説明しましたが、簡単に言っちゃえば

講師:これっす!笑

講師:「とにかく、わかりやすく」って部分を意識して、今回のワークで皆さんに設計書を書いてもらいます!!



・設計書を書こう!

講師:それじゃあ、今回のワークの概要を紹介します。

講師:本日のワークは、、、


...!?

講師:どういうことか、概要を説明しますね笑

*概要
目標:相手が、自分の作成したドキュメントをもとにお題の折り紙を折る
・2グループに分かれ、グループごとに折り紙のお題を決める
・お題の折り紙の折り方をドキュメント化する
・相手グループのメンバーと2人1組になり、相手にドキュメントを見せて折り紙を折れたら成功

講師:流れはこんな感じで、次にルールを説明します!

社員:質問いいですか...?

講師:はい、どうぞ!

社員:「お題を直接口にするのはNG」ってことは、ドキュメントに書くのはアリってことですか?

講師:その通りです!笑
完成物がどういうものかわからないまま作業してもわからないと思うんで、何を作るのかはちゃんと書いてください!

講師:そして今回は作成したドキュメントをメンバー全員で見せ合って、レビューします!
どこが読みやすかったか、逆にどういうところが読みにくかったか、全員でフィードバックして設計を日本語化するスキルを磨きましょう!

ーーということで、作業開始!


社員:お題決めたけど、折り方がわかんないっす・・・笑

社員:ドキュメント化する時間がない・・・!笑

・・・(もくもく)


講師:・・・はい、時間なんでそこまでで!!


・設計書の通り完成させよう!

講師:作成、お疲れ様でした。そしたら、グループ相手同士でペアになってもらって、相手から貰ったドキュメントで折り紙を作ってみてください!

社員:・・・あ、ここをこうするのか!

社員:え、わかんない・・・笑


ドキュメントが難しくて読めなかった人や、自分より読みやすいドキュメントを見て改善点を探してる人など、十人十色のリアクションが見れました!

講師:できましたか?そうしたら、全員でドキュメントのレビューをしましょうか!

社員:このドキュメントの書き方なんすけど・・・

社員:ここの文章は簡単すぎてどこなのかわかんないですね・・・

設計において大事なのはとにかく、わかりやすく書くこと。
作成するドキュメントは簡潔すぎても、細かくて具体的すぎてもいけません。
作成し、他のメンバーと比べて、自分のドキュメントがどれくらいの完成度か、考えられる時間でした!

講師:今回のワークは、実現したいことの日本語化といったスキルを磨いていくような内容だったんですけど、これはIT業界に限らずいろんな場面で使えるようなスキルなんで、ぜひ鍛えてもらえればと思います!

・まとめ

今回の勉強会では、折り紙の書き方を通してドキュメントの書き方を学びました!

システム開発をするエンジニアのお仕事は、プログラムコードを書くことがメインだと思っていましたが、
コードを書くための要件定義や基本設計といった、コードを書かない部分の仕事まで目が行き届いてませんでした!
未経験からでもわかりやすく学習できる企画などは、今後も積極的に参加していきたいですね!


いかがでしたでしょうか?iXiAでは今回のようなカリキュラムを通して、未経験のメンバーのスキルアップに力を入れています!
プログラミングの経験がある方も、そうでない方も、是非一度話しを聞きにきてくださいね!!


株式会社iXiAでは一緒に働く仲間を募集しています!


株式会社iXiAでは一緒に働く仲間を募集しています
2 いいね!
2 いいね!
同じタグの記事
今週のランキング
株式会社iXiAからお誘い
この話題に共感したら、メンバーと話してみませんか?