プロジェクト構造について

[azu]

Gitbook推奨のプロジェクト構造があるのか調べる。

課題

• 文章とコードは章ごとにまとめるか？
• i18n化した際に構造上の変更が対応可能か？

[azu]

https://github.com/azu/promises-book Promise本の場合は文章とコードは章でまとめてた。 i18n対応が難しい感じがあった。

• Promise本で取り組んだ電子書籍の開発ツール、CI、継続的リリースについて | Web Scratch

で細かく書いてた

[azu]

現在

.
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── SUMMARY.md
├── book.json
├── content
│   ├── introduction
│   └── jQuery
└── package.json

[azu]

各章ごとにsrcと.mdを持つのは正しいと思う。 i18n化した時にそこはi18nするべきであると考えられるから。

srcを章以下に置きたい理由はincludeするため

他のもの、test、package.jsonなどはプロジェクト全体の共有資源とかんがえるのが良いのかもしれない。

[azu]

.
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── SUMMARY.md
├── book.json
├── content
│   ├── introduction
│   └── jQuery
├── test
│   ├── introduction
│   └── jQuery
└── package.json

i18n化した時が美味しくない感じがする。

.
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── SUMMARY.md
├── book.json
├── content
│   ├──  src
│   └── ja
│        ├── introduction
│        └── jQuery
├── test
│   ├── introduction
│   └── jQuery
└── package.json

[azu]

.
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── SUMMARY.md
├── book.json
├── src
├── ja
│    ├── introduction
│    └── jQuery
├── test
│   ├── introduction
│   └── jQuery
└── package.json

とするのが http://help.gitbook.com/format/languages.html に も対応できるので妥当…

[azu]

srcのコメントは英語でできるだけ国際化するというのが妥当な感じが

[azu]

GitBookのlocalはなんかjpだけど、正直訳の質がよくないのであえて乗る必要がなさそう

[azu]

https://github.com/azu/JavaScript-Plugin-Architecture/issues/5#issuecomment-135952457 でやろう