问题标签 [design-documents]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
4 回答
1869 浏览

uml - 设计文档与 UML 还是两者兼而有之?

我很难坐在 UML 面前并从中获得价值,因为它看起来几乎与编程一样多(如果您使用表达性语言)。我发现编写自然语言比创建复杂的图表更能告诉我有关软件项目的信息。虽然我是 UML 的新手,但我想知道其他熟悉 UML 的人:

  1. UML 是否值得花时间学习/做,即使对于中小型项目也是如此?
  2. 即使在团队中,精心设计的设计文档是否也足以让程序员保持目标以创建正确的代码?
0 投票
1 回答
108828 浏览

architecture - 设计文档(高级和低级设计文档)

高级和低级设计文档实际上包含哪些内容?(我特别想知道这两个文件中都绘制了哪些图表)。

我已经浏览了很多资源,但我有点困惑。

据我所知... HLDD 包含上下文图和架构图 LLDD 包含流程图、表示实体的图以及这些实体之间的关系、序列图。

0 投票
1 回答
82 浏览

json - 为什么这些 CouchDB 视图中只有一个有效?

我在 CouchDB 中有一些 type:"Person"和 type的文档"Account"

对于这些类型的所有文档的直接列表,我创建了以下设计文档_design/directory_views

此 JSON 在 JSONLint 上进行验证,并在将文档保存在 Futon 的源视图中时被接受。

蒲团列表directory_views/all_personsdirectory_views/all_accounts下拉列表中的预期。all_persons 创建正确的类型文档列表"Person",但all_accounts重定向回顶层All Documents,并列出所有内容。

为什么all_persons工作,但all_accounts失败?

PS。到目前为止,我在许多设计文档中都经历过这种行为。这个例子http://kore-nordmann.de/blog/couchdb_a_use_case.html#a-practical-example在同一个设计文档中显示了两个视图,所以我不认为每个文档只能有一个视图。

0 投票
2 回答
193 浏览

doxygen - doxygen 创建的文档叫什么

据我了解,“javadoc”是生成 html 文档的工具的名称,该工具的名称也为 javadoc。至少这就是我一直使用这些词的方式..

但是工具 doxygen 生成的输出叫什么?Doxygen 医生?多西医生?或者别的什么?

(在 C++ 上下文中的问题,如果重要的话)

0 投票
1 回答
2076 浏览

filter - CouchDB、all_docs 和使用 endkey 过滤设计文档

首先,这个问题 - 来自 all_docs 的过滤器设计文档 - 似乎已经像这里描述的那样得到了解决:https: //plus.google.com/+JasonDeRose/posts/1iP5tu3wVqw

并排在第一位。但是,突然在不同的设置中(实际上只是不同的部署),查询只返回一个空集合 []。似乎顺序发生了变化,没有 endkey="_" 返回完整的集合(包括设计文档)。我尝试了 endkey/startkey 的各种组合,但无法再次过滤设计文档。

最后我添加了一个过滤器并切换到 _changes?include_docs=true 来加载初始文档。我也考虑过定义一个视图,但不喜欢这会导致数据复制和更改源的一些不便(在另一个上下文中需要)。另一方面,过滤器将为每个文档执行。

endkey=%22_%22 不再起作用是一个错误吗?有没有更方便,仍然有效的方法?

0 投票
1 回答
1693 浏览

filter - 使用 PouchDB 过滤设计文档

我正在使用设计文档来确保只有所有者才能修改文档。如何防止 couchdb 复制此设计文档?

0 投票
1 回答
183 浏览

javascript - 包括设计文件制造

factoryng中的默认设置会过滤掉设计文档。我怎样才能包含这些设计文件?

0 投票
1 回答
856 浏览

couchdb - CouchDB 无法识别我的新设计文档中的更新功能

我创建了一个具有虚拟更新功能的新设计文档。但是当我尝试对其进行测试时,CouchDB 并没有在设计文档中识别我的功能。

下面是我的设计文档:

但是当我尝试使用 put 调用此更新函数时,得到 404。请求:

回复:

我看到一切看起来都很好,找不到问题。任何帮助将不胜感激。

0 投票
1 回答
46 浏览

.net - 在 TDD 方法中,我们可以有详细设计文档吗?

我们刚刚进入这种 TDD 方法。除了其他最初的打嗝之外,我们还对是否创建任何详细设计文档(DDD)感到困惑。在传统的方式中,我们曾经遵循这条路径, - 业务需求文档> 功能规范文档> DDD> 构建> 测试> ... 在 DDD 中,我们曾经使用类图、序列图和数据库设计完成所有实现细节。我们了解到,TDD 驱动代码实现并遵循契约式设计原则。所以所有的类都将与单元测试用例一起创建。

如果我们需要任何设计文件,你能指导我吗?如果是,那应该是什么内容?

0 投票
1 回答
76 浏览

javascript - 如何确保某些字段包含在 CouchDB 数据库中?

我试图找到一种方法来确保某些内容存在于 CouchDB 数据库的文档中。我认为最好的方法是使用“validate_doc_update”设计文档。过去我创建了一个检查用户是否有权对数据库进行更改的程序,因此我尝试在其中包含此附加代码。但是,它在 CouchDB 中不被识别为可编译代码,我不确定为什么(参见下面的代码)。有谁知道我在哪里弄乱了这段代码以使其无法编译,或者是否有更好的方法来确保某些字段包含在更新的文档中?

这包含在名为“_design/BGdesign”的同一数据库中的设计文档中:

}