はじめての技術書ライティング―IT系技術書を書く前に読む本

目次

第1章 準備

1.1 なぜ書き方を学ぶ必要があるのか

1.1.1 技術文書の3条件

1.1.2 最初から「よい原稿」を目指す

1.2 その1冊にふさわしいルールを作る

1.2.1 1冊の中で一貫性を保つ

1.2.2 横書きと縦書き

1.3 出版物として完成するまでの流れ

1.3.1 原則として逆流はしない

1.3.2 随時バックアップを作る

1.4 電子書籍の基礎知識

1.4.1 サイズと色数

1.4.2 ページの概念

1.4.3 まだ電子書籍を使っていない場合

 

第2章 企画と構成

2.1 テーマを決める

2.1.1 「何を使って」ーテクノロジーを決める

2.1.2 「誰が」-対象層を決める

2.1.3 「何をする」-目的を決める

2.1.4 身近な人から考える

2.1.5 裏テーマを考える

2.2 構成を考える

2.2.1 構成を考える方法

2.2.2 一方向に組み立てる

2.2.3 入門書に忘れがちなこと

2.2.4 たくさんのことを盛り込まない

2.2.5 スケジュールから考える

2.2.6 横断的なテーマは難しい

2.2.7 対象は最新環境とする

2.3 企画書を書く

2.3.1 タイトル

2.3.2 企画要旨

2.3.3 目次案

2.3.4 対象読者

2.3.5 判型とページ数

2.3.6 締切

2.3.7 サンプル原稿

 

第3章 本文の執筆

3.1 ツールの選択

3.1.1 ソフトウェア

3.1.2 ハードウェア

3.1.3 執筆画面の設定

3.2 書き方の基本

3.2.1 文体を決める

3.2.2 名称は正確に

3.2.3 用語を統一する

3.2.4 事実を確認する

3.2.5 私見は区別する

3.3 見出しの付け方

3.3.1 階層は4つまで

3.3.2 番号と記号を付ける

3.3.3 文体をそろえる

3.4 本文の書き方

3.4.1 字下げと空白行

3.4.2 英数字

3.4.3 カタカナ表記

3.4.4 カギ括弧

3.4.5 強調

3.4.6 ルビ

3.4.7 記号

3.4.8 定義の説明

3.4.9 箇条書き

3.4.10 別の箇所の指示

3.4.11 参考文献の紹介

3.4.12 著作物の引用

3.4.13 脚注

3.4.14 リード

3.4.15 前書きと後書き

3.4.16 カコミ

 

第4章 本文の補助要素

4.1 ファイルを分けるか検討する

4.1.1 作成に使うツール

4.1.2 ファイルの渡し方

4.1.3 ファイル指定と命名ルール

4.2 電子書籍特有の注意

4.2.1 最右zに配慮する

4.2.2 色数に配慮する

4.3 キャプション

4.3.1 図を支持する場合

4.4 スクリーンショット

4.4.1 カスタマイズはしない

4.4.2 著者自身の環境との両立

4.4.3 Windowsで撮影する

4.4.4 macOSで撮影する

4.4.5 iOSで撮影する

4.4.6 AndroidOSで撮影する

4.4.7 その他の端末で撮影する

4.5写真

4.6 概念図

4.7 画像への書き込み

4.7.1 著者が作成する場合

4.7.2 編集者が作成する場合

4.8 表

4.9 プログラムコード

4.9.1 正確に書く

4.9.2 インデント量を統一する

4.9.3 行ごとに解説する

4.9.4 桁数を合わせたい場合

4.10 数式

 

第5章 推敲と構成

5.1 粗原稿から完成原稿へ

5.1.1 校正は推敲とどう違うのか

5.1.2 なぜ推敲が重要なのか

5.1.3 校正で避けるべきこと

5.1.4 「著者が偉い」は思い違い

5.2 推敲の方法

5.2.1 印刷する

5.2.2 他人に読んでもらう

5.3 悪文の例

5.3.1 執筆に疲れてくる

5.3.2 表記が統一されていない

5.3.3 文や段落が短すぎる/長すぎる

5.3.4 接続詞を使わない

5.3.5 重要なことを途中で書く

5.3.6 1つの文に複数のトピックを入れる

5.3.7 修飾の関係がわからない

5.3.8 括弧で長い文章を挟む

5.3.9 本文中に箇条書きを挟む

5.3.10 同じ意味を難しく言う

5.3.11 同じ意味を繰り返す

5.3.12 何度も同じ語を使う

5.3.13 ひらがなが長々と続く

5.3.14 難しい漢字を使う

5.3.15 名詞止、体言止めを使う

5.3.16 名詞を「の」でつなげる

5.3.17 過度な造語や当て字をする

5.3.18 俗語を使う

5.3.19 漢字や慣用句を間違える

5.3.20 単語の意味を間違える

5.3.21 専門用語を専門用語で説明する

5.3.22 主語が読者ではない

5.3.23 コマンド名で指示する

5.4著者校正の方法

5.4.1 著者校正のツール

5.4.2 Acrobatの注釈ツール

5.4.3 ノートを付ける

5.4.4 マーカーを引く

5.4.5 注釈とコメントはセットで

5.5 校了から発売まで

5.5.1 PRは一般向け告知の後で

こどもプログラミングドリル (Scratch(スクラッチ)編)

新わかりやすいJava オブジェクト指向徹底解説

関連記事

  1. エンジニアのためのWordPress開発入門 (…

    目次第1章 WordPressとは1.1 WordP…

  2. WEB+DB PRESS Vol.111

    目次特集1 詳解 Rails 6 新機能…

  3. OAuth徹底入門 セキュアな認可システムを適用…

    目次第1部 はじめの一歩1OAuth2.0とは何か?…

  4. 利益&回転率がアップする 最適在庫完全バイブル …

    目次第1章 これからの在庫管理に必要な基礎知識1 そ…

  5. 親子で学ぶScratch学習ドリル どすこい! …

    目次プログラミングの世界へようこそお父さまお母さまへ…

  6. できるキッズ 子どもと学ぶ JavaScript…

    目次第1章 JavaScriptプログラ…

  7. 基礎から学ぶ人工知能の教科書

    目次第1章 人工知能とは1.1 人工知能の概要…

  8. PHPフレームワーク Symfony 4 入門 …

    目次1 Symfonyを準備する1-1 インストール…

最近の記事

  1. Microsft .NET C#
  2. れいといちかとまほうのトンネル
PAGE TOP