【Vim 入門本】現在の状況と貢献の仕方について

[monaqa]

現在、Vim に関する入門本の執筆に取り組んでいます。

ここでは入門本について以下をアナウンスします。定期的に更新予定です。

• 現状の共有
• 貢献を検討されている方への案内

[monaqa]

決まっていること

• 全体のテーマ: Vim のあらゆるトピックに関する入門書

  • トピックの例
    • Vim の標準機能（オペレータや Quickfix）
    • プラグインの入れ方
    • プラグインの作り方
    • Vim へのコントリビュートの方法

• 想定読者: 初心者から上級者まで、あらゆる Vimmer

  • Vim の存在は知っているが、基本的な操作方法を知らない、自信がない人
  • Vim の基本操作は知っているがプラグインの導入方法や使い方が知りたい人
  • Vim が好きで、Vim に貢献したい人

• 扱うトピック

  • [beginners-guide] Vim 入門書に載せるコンテンツについて #1 (comment) で議論したトピックを扱う予定です。
    • 新たにトピックが追加される可能性もあります。
    • 議論によってはトピックが統合されたり削除されたりする可能性もあります。
  • トピックは今後 begginers-guide-topics project で管理します。

[monaqa]

現在の状況

• ある程度トピックの洗い出しが済んだので、章ごとに以下を決めたい段階です。
  • 具体的に書くこと
  • 執筆・レビュー担当者
  • 章のテンプレート (各 Chapter（トピック）の大まかな雛形・スタイルの決定 #2)

[monaqa]

本への貢献を行う方へ

貢献をご検討くださりありがとうございます。現時点でいくつかの貢献方法があります。

• トピックを執筆する
• 新たなトピックを提案する
• トピックをレビューする

トピックを執筆したい

執筆するためには vim-jp-book org. に所属する必要があります。vim-jp Slack で @monaqa 宛にお声がけください。招待を送ります。

参加できたら、Project の "Inbox" にあるトピックのうち Assignee が空になっているものから自分が書きたいトピックを選び、以下を実施してください。

• 執筆の宣言

  1. 自分を Assign する。
  2. 章のアウトラインをコメントする。
     • 他の章を書く人が参考にするためのものです。大雑把でかまいません。
  3. Iteration に、「自分が記事を書き上げられそう（＝PR が出せそう）な期間」を埋める。
     • 本の簡単な進捗管理のためです。目安で問題ありません。
     • あまりに遅延が激しい場合は他の人に割り当て直すこともあるかもしれませんが、現時点でそこまで厳格な運用は想定していません。
  4. Project の Status を "Ready" にする。

• 執筆

  • 具体的な執筆手順は検討中です。決まり次第追記予定です。

新たなトピックを提案したい

どのように進めるか検討中です。決まり次第追記予定です。

レビューしたい

どのように進めるか検討中です。決まり次第追記予定です。