All geek questions in one place

Where and what do I need to do to document my Ruby on Rails application?

I am using Ruby on Rails 3 and I would like to start documenting my internal application in addition to using comments in files. To do this, I decided to create documentation files in some folders already available in my application.

But I have some questions / doubts:

  • Where (in which folder of the RoR application) should I create documentation files?

    Note. I would like to allow only developers to view these files. No public access.

  • What file extension do you recommend to use?

    Please note: in the documentation I need to insert plain text.

  • Do you have a general recommendation on this topic?

    Example: is this the wrong approach?

+3
source share
3 answers

There is a folder with a name docwhere you can post your documentation (only in any case public) README_FOR_APP- this is a place where you can submit your application and post notes for private users.

readme.rdocor readme.mdin root folder- another great place for instructions and copyright, if you look at some open source project on github ( devise ), you will see that this file is displayed by default in the project directory.

doc , odt ods BOUML uml. TODO.TXT, , ( TODO )

(yard), , .

( ), git, , .

( ), , ubuntu one dropbox - google docs.

+2

, , .

, , doc rails, , . , , ( / ) ( , scm). , , , - , - .., - , ( , ), , (, , , , , ..).

, .txt . , ( ), .

, . /, , , , - - .

+1

Why not use a subdirectory docand rake doc:app?

0
source

Source: https://habr.com/ru/post/1789527/

More articles:


All Articles