LoginSignup
0
1

More than 5 years have passed since last update.

技術文書執筆の体裁のtips

Posted at

わかりやすく読みやすい,価値の技術文書の執筆において,文書の体裁を整えることは極めて重要な要素である.いくら内容が良いものであっても,その具体的発露である文書の体裁が乱れていると,読みやすさは大きく損なわれ,文書が本来持つ価値が適切に伝えられない.結果として,その文書が持つとされる価値そのものの低下にもつながる.あまりにもひどい場合には,体裁の乱れそのものに読者の注意が集まり,肝心の内容が置いてけぼりになってしまう場合もある(例:ヒッグス・ボゾン粒子発見を発表するCERNのスライドデザインが話題に).

体裁に関する細かいルールを全て覚えておくことは容易ではないため,この記事では,技術的文書の体裁に関するtipsを随時追加する形でまとめていく.
内容に関しては,著者の関心である情報技術系の論文執筆を中心としたものになるため,必ずしも全ての人にとって正しい指針ではないことに注意されたい.

文書のメタデータに関して

  • 表題
    • タイトルが長く改行が入る場合には,単語の途中に改行位置がこないよう調整する
  • 著者名・所属・連絡先
    • 文書提出先の投稿規定に従う
    • 論文の場合,最低でも著者のうち一人の連絡先を記載すべき

句読点

情報系の論文に関しては,多くの場合全角文字の「,」「.」を句読点として用いることが一般的である.

...

... 大幅に加筆予定(忘れなければ)

参考文献

0
1
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
0
1