Support #2572

Support #2255: [English version] Sphinxを用いたドキュメント作成方法の整理

Developer's guide ドキュメントの修正

Added by Kenji Maruyama about 4 years ago. Updated about 4 years ago.

Status:完了チェック待ちStart date:05/27/2014
Priority:NormalDue date:
Assignee:Kenji Maruyama% Done:

90%

Category:-Estimated time:1.00 hour
Target version:-

Description

http://redmine.groonga.org/issues/2255#note-4 の 修正になります。

History

#1 Updated by Susumu Yata about 4 years ago

Description には,どのドキュメントをどのように修正するつもりなのか書いてくれると助かります.

http://redmine.groonga.org/issues/2255#note-4 の 修正になります。

これだけでは,リンク先を見に行かないと内容がわかりませんし,どのような修正をするつもりなのかもわかりません.

#2 Updated by Kenji Maruyama about 4 years ago

Description には,どのドキュメントをどのように修正するつもりなのか書いてくれると助かります.

次回からリンク先を読まずとも Description を読まば良いように書きます。

今回のDescriptionとして、

Developer's guide ドキュメント

http://mroonga.org/docs/developer.html#developer-s-guide の修正になります。

具体的には、

Developer's guide に書かれた手順の確認、表記の確認を行い、修正すべきところをリストアップします。

また、http://redmine.groonga.org/issues/2255#note-4 で指摘された以下の点について修正します。


    BTS
        何の略かわかりにくいように思うので,最初は Bug Tracking System (BTS) とした方がいいんじゃないかと思います.
    Generally speaking
        自分達のことなので,ちょっと大袈裟な気がします.
    Roadmaps
        これは Roadmap が正しいと思います.
    git, github
        ロゴは git, github ですが,文書においては Git, GitHub が使われているようです.
    please make clone in read/write mode, and then commit and push please
        最後の please が余計ですかね.
    mroonga
        Mroonga ですね.
    cutter
        Cutter ですかね.
    ReStructuredText
        reStructuredText っぽいです.

#3 Updated by Susumu Yata about 4 years ago

  • Status changed from 新規 to 担当者作業中

We, the Mroonga development project, are doing Ticket Driven Development by using a Bug Tracking System (BTS) named Redmine.

-> The Mroonga project uses Redmine for Ticket Driven Development.

こんな風にした方がすっきりするかなーと思います. 後,単語の並びを見れば意味は通じると思いますが, Ticket Driven Development という言葉は実のところあまりグローバルなものではないようです.

We decide our roadmap by discussing in off-line or on-line meetings.

-> We draw up our roadmap by discussing in off-line or on-line meetings.

decide は違うような気がします.

Roadmap specify the list of adding features in each version.

-> The roadmap specifies the list of adding features in each version.

We would like to develop in the following procedure.

-> ???

would like to だと願望表現になってしまいます. それと, develop を自動詞として使っているため,「我々は以下の手順で発展していきたい」みたいな意味になりそうです.

#4 Updated by Susumu Yata about 4 years ago

Contents of the source tree のところ, lib/ にもソースファイルが含まれています.

#5 Updated by Kenji Maruyama about 4 years ago

  • Status changed from 担当者作業中 to 新規

http://redmine.groonga.org/issues/2572#note-3 レビューありがとうございます。

レビュー前の修正点以下になっています。


Link先修正
  http://redmine.groonga.org/projects/show/mroonga (リンク切れしていたので、以下に変更した方がよさそうです)
    => http://redmine.groonga.org/projects/mroonga
    
Development environment
   開発環境のバージョン情報は古くなっています。
   MySQL, Groonga, Cutter, Sphinxについて常に最新のバージョンに対応していくと思うので、他がバージョンアップするたびにドキュメントを更新することよりもバージョン情報は表記せずにlink先を掲載した方が良さそうです。
  
ソースコード拡張子 
   h=>hpp,  cc=>cpp

test/sql/ =>  mysql-test/ 変更, test/sql/r/, test/sql/t/削除、文言を以下に修正

  The directory for tests by SQL
     
  SQL test scripts are included in each test case 't/' directory, that are also the definition of currently available SQL statements
  
  The expected results of SQL tests are included in each test case 'r/' directory , that are also the definition of the current specification of supported SQL

doc/en/ -> doc/source/
   English documents in Sphinx format

doc/ja/ 存在しないので、削除した方がよさそうです.

上の修正と http://redmine.groonga.org/issues/2572# の 修正と合わせて, wikiに記載

wiki(reStructuredText format) : http://redmine.groonga.org/projects/mroonga/wiki/Developer_guide

引き続きレビューされた所の修正と確認をします。

#6 Updated by Kenji Maruyama about 4 years ago

  • Status changed from 新規 to 担当者作業中

#7 Updated by Kenji Maruyama about 4 years ago

  • Status changed from 担当者作業中 to 完了チェック待ち
  • % Done changed from 0 to 90

http://redmine.groonga.org/issues/2572#note-5 の修正を含めて, commit しました

Also available in: Atom PDF