はじめて執筆する方へ

執筆に興味を持ってくださりありがとうございます！ここでは執筆にあたって知っておくべきことを説明します。

本書のターゲットを意識してください

「はじめに」の「誰に向けて書かれた本か？」に記載されている読者をイメージして、その人にとってちょうどよいレベル感を想像して書いてください。

📄️ トップ

TypeScript入門『サバイバルTypeScript』〜実務で使うなら最低限ここだけはおさえておきたいこと〜

まったくのプログラミング初心者はターゲットではないため、たとえば「変数とは」「関数とは」といった初級すぎるところは説明を割愛します。しかし、変数という概念は他のプログラミング言語で知っているが、JavaScriptの構文として変数宣言をどう書くかは知らない可能性があります。なので、プログラミング経験者をイメージしつつも、JavaScriptの知識は無いかもしれないプログラマーを想像してください。

文体・スタイルを周りに合わせてください

基本的な文体スタイルは次のページで定めています。

📄️ 文体・スタイル

みんなで執筆しても同じような文体になるようにするためのガイドラインです。

用語はできるだけ統一してください

用語の表記ゆれができるだけ起こらないよう注意してください。「サーバ」や「サーバー」、「インターフェイス」「インターフェース」など、できるだけ既存のものに統一してください。神経を尖らせず、意識できる範囲で構いません。後で誰かが見つけて修正できます。

英語の訳語は一定の決まりがあります:

📄️ 日英対訳表

本書では専門用語を翻訳するにあたって、次の訳語を採用します。

プルリクする前に話し合おう

本プロジェクトのコラボレーションは「プルリクする前に話し合おう」を原則としています。改善点が見つかってもすぐに着手せず、まずはissueにて話し合いを行う必要があります。詳しくは次のページをご覧ください。

📄️ チケット駆動(プルリクする前に話し合おう)

「着手する前に話し合おう」をチケット駆動で行う流れについて説明します。

途中でも公開しましょう

書き途中でもプルリクエストして構いません。途中までの情報でも、情報ゼロよりは読者の役に立ちます。

環境構築からプルリクエストまでの流れ

具体的な環境構築からプルリクエストまでの流れは次のページをご覧ください。

📄️ 環境構築からプルリクエストまでの流れ

環境構築から執筆、公開までの流れと手順を説明します。