#TitaniumMobileユーザ会doc-ja(APIカタログ)部会編集方針(案)
- GitHub上にMarkdownで記述する。
- 既存のdoc-jaのUIカタログの粒度、APIカタログぐらいの粒度(範囲の見直しは必要かと)でドキュメントを起こす対象とする。
- 一覧を早急にまとめ、状況を整理、Issuesに投入などする。
- 作業分担はそこからさきで。
- 名称はAPIカタログで統一する。Guidesも従来のdoc-ja的なものなので。
- 構成は次のようにする
- 機能概要と動作イメージ(可能なら動画もあったほうがよい？)
- 簡単な用例 コードサンプル
- バリエーションのあるもの(TextField、Pickerのような)はそれぞれの用例を列挙
- 主要なプロパティやメソッド、イベントの紹介(緑本のイメージ)
- 関連するドキュメントへのリンク
- コード例はKitchenSinkから流用し、スニペットとして動くようにする。CommonJSスタイルにこだわらない(利用者が脳内変換したほうが融通が利く)が、パーツ分割が発生するようなもの(Window,SplitViewなど)はCommonJSに乗っ取った形にする。
- コード例のコメントはできる限り意をくんだ訳する。
- 完全翻訳よりも日本語的な読みやすさを。
- 一覧表のテーブルHTML記述ルールは別途設ける。