Help us understand the problem. What is going on with this article?

技術情報を記録するときの記述パターン

More than 5 years have passed since last update.

『パターンによるソフトウェア構成管理』の記述形式を参考に、なにかしらの技術記事を書く時のパターンを作成してみた。

タイトル

後に内容の理解がしやすいよう、ポイントとなるキーワードを使ってタイトルを作る

コンテキスト(状況)

どんな背景でどういう状況にいるかを記述する

Pain(悩み、問題)

どんな事に困っているのか、どういう状況になるのを望んでいるかを記述する

対応方法

どういう活動を行って、Painを解決するのかを記述する

検討課題

関連するPainや対応方法、または対応方法に関する懸念など、別の事柄への展開や本件を深めるための内容を記述する

Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away