Skip to content

Instantly share code, notes, and snippets.

@LambdaNote LambdaNote/before.md Secret
Created Nov 18, 2018

Embed
What would you like to do?
記事を書き始める前に

記事を書き始める前に

ラムダノートへの寄稿を検討いただき、ありがとうございます。 この資料は、記事を執筆していただく方に向けて、当社からのお願いをまとめたものです。

記事の方針を共有する

まずは、以下の質問について、できるだけ具体的な回答を考えてみてください。

  1. この記事を理解するために、読者が最低限できてほしいこと(〇〇は理解していてほしい、△△を使った経験がほしい、など)
  2. この記事を読むと、どうなれるか(〇〇の論文が読めるようになる、△△を作れるようになる、□□で話ができるようになる、など)
  3. この記事に対する執筆者自身の専門性(研究者である、職務で〇年間利用している、実装を開発した、など)
  4. この記事に近い内容の既刊書や記事(参考文献とは別に)

こちらから依頼して記事を書いていただく方もいるので、ともすれば失礼なお願いになり恐縮ですが、 これらの情報をうまく共有できると、対象読者に向けて最適な執筆と編集ができるようになると考えています。

記事のライセンスについて

執筆いただいた記事は、原則として、CC BY-NC-SAライセンス(https://creativecommons.org/licenses/by-nc-sa/4.0/deed.ja )を適用します。 その際、ラムダノートも共同Creatorとして併記させてください。

Creative CommonsのBYライセンスなので、当社が発行する書籍など以外の場でも、商業媒体でなければ執筆者の方が自由に公開可能です。 ご自身のブログ、Webサービス、論文誌、同人出版などでご利用ください。 その際には、共同Creatorであるラムダノートの名称についても表示をお願いします。

Creative CommonsのSAライセンスなので、他の媒体で利用の際は、CC BY-NC-SAライセンスであることの表示をお願いします。

Creative CommonsのNCライセンスなので、商業誌などへの転用の際は当社にもお声がけください(特に理由がなければ許可させていただく方針です)。

執筆と編集の進め方

GitHubのプライベートリポジトリをラムダノートが用意します。 そこが記事のメインリポジトリです。

リポジトリの使い方は厳密には規定しませんが、記事1つにつきディレクトリを1つ掘る、という大方針でお願いできればと考えています。 つまり、トップディレクトリ以下に記事用のディレクトリが並ぶ構成です。 通常、各ディレクトリには、 *.md が1つと画像ファイル用のディレクトリなどが含まれることになるはずです。

/ -+- /1st -+- foo.md
   |        +- images --- foo00.png
   |
   +- /2nd --- bar.md
   |        +- images -+- bar00.png
   |                   +- bar01.png
   |...
   +- /nth --- buz.md
            +- images --- buz00.png

上記とまったく異なる構成を検討されている場合はご相談ください。

GitHub上では、編集者もgitを使って共同作業していきます。 編集者は、最初のうちはPull Requestとして編集を提案します。 Pull Requestに対するコメント機能を使って議論や修正を重ねてからmergeしていただいてもいいし、 とりあえずノールックでmergeしていただいてから修正を上書きしていただくのでもかまいません。

共同作業の様子をみて、トリビアルな修正は直接コミットしていく場合もあります。 ただし、編集者による変更が絶対ではないので、必要に応じてrevertなどしてください。

編集の意図はなるべくcommitメッセージとして言語化しますが、日本語の読みやすさを上げる目的での編集については、 あまり具体的なメッセージを残せない場合があるという点について、あらかじめご了承ください。 これは、そうした編集の意図を言語化するのが困難だからというのが主な理由です。 同じ理由で、GitHubのissueを立ててから編集というフローは原則としてとりません。

GitHubのリポジトリとは別に、フリーのSlackスペースを用意するので、編集意図などの疑問点はそこでコミュニケーションできればと思います。

GitHubでの日本語文章の共同作業の進め方に対する編集者の方針については、こちらのブログ記事もご参照ください。 (「執筆・編集のためのGit(GitHub)ワークフローを考えてみた」:http://note.golden-lucky.net/2016/05/gitgithub.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.