1
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 3 years have passed since last update.

マニュアル作成方法

Last updated at Posted at 2020-10-04

背景
201004 23:34:11
PJで環境構築等の手順書作りを任された。初めての作業で手間取った。
なんども作るが突っ返されかなり苦労した。
そこで得た知見を忘れないようにするための備忘録として残す。

優れたマニュアルとは?

【結論】

  • 相手が気持ち悪く感じないこと

【相手に不快感を感じさせないためのマニュアル作りのテクニック】

  • 色分け(できたら3色までに抑える)
  • 構成を整える
  • 文章の書き方にルールを設ける
  • 同じ言葉、単語を使うようにする

参考にした記事(いつもありがとうございます。)

ドキュメント作成スキル向上を目指す人向けおすすめ記事まとめ

1
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
1
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?