技術文書は、書き方をする必要があります

ビジネスモデルのコード:開発者のための

1.参加のガイドライン

2.コードスタイル

3.アーキテクチャ設計

4.デザイン

5.実装の詳細

6.コードレビュー

7.コードの統合

8.ライン上に展開します

9.ピットガイドを強化しました

10.FAQ

 

ユーザ指向:クラスライブラリ、コードフレームタイプ

1.コードを取得

2.クイックスタート

3.デモ

4.インターフェイス説明

5.モジュール説明

6.高度なトピック(アーキテクチャ設計;. Bのベストプラクティス;.は、競合製品を比較C。)

7.FAQ

 

ドキュメント管理:

合流、Googleドキュメント、gitのか、いくつかの他の自己ドキュメント管理プラットフォーム

マークダウンを使用することを学ぶことをお勧めします

おすすめ

転載: www.cnblogs.com/biang/p/11671871.html