sakura-editor / management-forum

管理・運用向けフォーラム(Issues をフォーラム代わりに使う)
2 stars 0 forks source link

wikiコンテンツの拡充について #23

Open berryzplus opened 6 years ago

berryzplus commented 6 years ago

せっかくwikiがあるのでコンテンツを充実させたいと考えております。

このwikiの話。 https://github.com/sakura-editor/sakura/wiki

いまのところ、wikiの目次はこんな感じです。

05.Members
10.DevelopmentPolicy
50.CodingTips

タイトルに番号がついていて、かつ、番号が飛んでいる、ということは、何かしらの構成を組むことが想定されていたんではないかと思っています。

主観的イメージだとこんな感じ・・・。

20. specification(仕様。俗な言葉で要求仕様。要件定義にあたる話。)
30. design(設計。俗な言葉で基本設計。外部設計にあたる話。)
40. class specification(詳細仕様。01.diagramがあって、クラス設計を書く雰囲気。)

「30.design」のページ作って中身書いていこうと思うんですけど、意図(というか雰囲気)あってますか?

内容的には、前に書いてたエディタプロセスと管理プロセスの話とか、エディタウインドウ(フレーム)が編集コマンドを実行する仕組みとか、ざっくりしたものを書いていくつもりです。

雰囲気的な話、20.specificationについてはhelp参照、40.class specificationについてはdoxygen参照でよいような気がするので、人力でドキュメント起こす必要があるのは30.designだけだと思っています。

今週いっぱいくらい様子を見て、とくに反論なければページ作って進めていく所存です。

KENCHjp commented 5 years ago

とりあえず、Wikiをサイドバーでカテゴライズしてみました。 あとトラシューページ追加しました。 https://github.com/sakura-editor/sakura/wiki/Troubleshooting

berryzplus commented 5 years ago

ふおおおお。(ほぼ忘れていたオチ

KENCHjp commented 5 years ago

どっかにぶら下げようとして、いいタイトルがあったので(笑)