<分区>
我正在使用 Ruby on Rails 3，除了在文件中使用注释外，我还想开始在内部记录我的应用程序。为此，我想在我的应用程序中已有的一些文件夹中创建文档文件。
但我有一些问题/疑问:
我必须在哪里(在 RoR 应用程序的哪个文件夹中)创建文档文件？
注意:我希望只允许开发人员查看这些文件。没有公开访问权限。
您建议使用什么文件扩展名？
注意:在文档中我必须插入简单的文本。
关于这个主题，您有什么一般性建议吗？
示例:这是一个错误的方法吗？
<分区>
我正在使用 Ruby on Rails 3，除了在文件中使用注释外，我还想开始在内部记录我的应用程序。为此，我想在我的应用程序中已有的一些文件夹中创建文档文件。
但我有一些问题/疑问:
我必须在哪里(在 RoR 应用程序的哪个文件夹中)创建文档文件？
注意:我希望只允许开发人员查看这些文件。没有公开访问权限。
您建议使用什么文件扩展名？
注意:在文档中我必须插入简单的文本。
关于这个主题，您有什么一般性建议吗？
示例:这是一个错误的方法吗？
最佳答案
有一个名为 doc 的文件夹，您可以在其中放置文档(无论如何只能访问 public)，README_FOR_APP 是存放文档的地方介绍您的应用程序并为私有(private)用户做笔记。
root folder 中的 readme.rdoc 或 readme.md 是另一个获取说明和版权的好地方，如果你看一下github上的一些开源项目(devise)你会看到这个文件默认显示在项目目录下。
我坚持使用 doc 文件夹来获取更具体的文档，我使用 odt 和 ods 来获取需求，并使用 BOUML 的默认扩展名来获取嗯。
TODO.TXT 提醒我要实现的功能(代码中的关键字 TODO 用于修复问题)
有一个文档插件 ( yard )，我认为他们很好地照顾了他们的文档。
如果您不想(也不想)生产服务器上的文档，请将其与您的 git 配置一起删除，我们有两台服务器，一台本地用于开发，一台外部用于生产。
编辑 如果您的文档经常受到来自不同用户的更新(尤其是在开始时)，您可能更愿意将该文件夹与 ubuntu one 或 dropbox 同步，甚至使用 google docs 之类的东西.
关于ruby-on-rails - 在哪里以及我必须做什么来记录我的 Ruby on Rails 应用程序？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/4876389/