标签: documentation

WPF快速入门文档

我是WPF的新手,并且正在寻找好的快速入门文档.我会从Adam Nathan那里购买WPF Unleashed这本书,但这更像是一个参考,而不是我认为的快速入门.
我只是想让你告诉我你最喜欢的链接和书籍,以及关于wpf开发的演示应用程序.

答案的重点应该是最佳实践,良好的可读性介绍(我讨厌msdn上的链接农场;)和全面的参考.

编辑:我将尝试在按类型排序的短列表中汇总所有建议.并且请尝试简要说明为什么您建议特别链接或该书.

图书:

博客:

链接:

演示应用:

documentation wpf

18
推荐指数
1
解决办法
7052
查看次数

寻找一个wiki风格的独立版本控制"安全"文档包

我的团队和我发现用wiki记录我们的项目(带有API的开发平台)对我们来说既有用又对用户有用.由于一些组织问题,我们被迫在没有网络连接的情况下进行多站点开发.我们已经改用DVCS(Mercurial)并取得了巨大的成功.维基文档证明是一个问题,因为中心站点是使用MediaWiki设置的.非现场人员无法访问或编辑维基.

是否有任何类型的wiki风格的软件包,它不需要服务器/数据库,并且可以在DVCS环境中使用?

更新:应该是开源和跨平台的

documentation wiki dvcs

18
推荐指数
2
解决办法
4772
查看次数

什么是收集业务规则文档的好方法?

我遇到了一个常见的情况,我敢肯定,我的业务规则文档分布在电子邮件,文档(现已过期)和即时消息中.这很臭.

我可以想到两个选择:Sharepoint(讨厌它,搜索功能很糟糕)或维基.

我希望在理想的解决方案中看到的一些事情:

  • 轻松更新:不要让我拉起Word来更新文档
  • 差异视图:有时您只需要查看新内容
  • 可订阅:逐页通知新更改
  • 基于角色:编辑和查看页面可以与角色相关联
  • 附件:轻松包含模型,文件等.
  • 搜索:这是一个谷歌后世界,我希望能够立即搜索和查找 - 除非我们使用的那个配置不正确,否则此类别中的Sharepoint会丢失
  • 附件限制:理想情况下,解决方案不允许上传我们随后称之为文档的一堆Word文档.我希望文档具有一致(简单)的格式.以PDF,txt等方式强制执行附件.

跟进我的wiki评论,看起来至少有3个wiki可以做我想要的(Incentive,SharePoint-Wiki-Plus,ThoughtFarmer).ThoughtFarmer,爱这个名字.

documentation wiki business-logic

18
推荐指数
1
解决办法
2826
查看次数

有哪些工具可用于记录jQuery插件?

我最近开始创建一些jQuery插件,我发现很难用我发现的文档生成工具来记录它们.我尝试过:JSDoc,JSDoc-toolkit,JGrouse和基于Web的工具.我最头疼的是我的插件被编码为一个大的匿名函数,我无法让工具识别我正在做什么,或者完全忽略它并让我输入方法的文档标签,物品等.

有没有其他工具可以帮助记录jQuery插件?

谢谢,桑德罗

javascript documentation jquery jquery-plugins

18
推荐指数
2
解决办法
2966
查看次数

Rxygen的R文档?

我发现R文档很重要,但创建/维护也很费时.有没有人使用过Roxygen,如果有的话,它是否有助于维护R包?我过去使用过Doxygen,但那些项目没有R包所需的man结构.

你可以在这里找到小插图.

documentation r roxygen

18
推荐指数
1
解决办法
1363
查看次数

有什么方法可以使用JAX-WS从Javadoc生成WSDL文档吗?

我希望可以使用某种类型的扩展(尽管我认为我的希望是愚蠢的乐观).

   /**
     * <p>
     * Gets the {@link ResultObject} given the identifier. The following
     * fields are not available for some users and will contain a null value:
     * </p>
     * 
     * <ul>
     * <li>{@code resultObject.comment}</li>
     * <li>{@code resultObject.anotherObject.actionById}</li>
     * <li>{@code resultObject.anotherObject.actionByName}</li>
     * </ul>
     * 
     * <p>
     * The {@code daysInPurgatory} value will be {@code -1} when not
     * applicable
     * </p>
     * 
     * @param requestUser
     *            the user initiating the request
     * @param identifier
     *            the id of the …
Run Code Online (Sandbox Code Playgroud)

java documentation wsdl jax-ws wsgen

18
推荐指数
2
解决办法
1万
查看次数

如何在c#xml docs中引用枚举常量

我想记录枚举类型字段的默认值:

/// <summary>
/// The default value is <see cref="Orientation.Horizontal" />.
/// </summary>
public Orientation BoxOrientation;
Run Code Online (Sandbox Code Playgroud)

编译器警告它无法解析引用.前缀F:或M:使编译器静音,但E:也可以,所以我不确定哪个前缀是正确的.

c# documentation enums xml-documentation

18
推荐指数
1
解决办法
5606
查看次数

如何为IT资产创建"依赖关系图"

我的一位客户正在尝试为他们公司使用的各种应用程序创建一个相互依赖的交互式"矩阵"(这是一家拥有约2500名员工的旅游和休闲公司).

这个想法(仍处于原型阶段)是基于Visio或类似工具创建一种Map,它跟踪公司中所有IT资产之间的通信和相互依赖性,以便当有人要求进行更改时,他们可以获得概述影响.

这是在一个随意的环境中提到的,我不负责直接处理这个问题,但我确实已经在模糊相关的方法论(Zachman框架)方面贡献了我所知道的一点点.

我想听听这里的人们是否知道可能有助于这种努力的方法论或工具,以及他们是否有任何特定的经验可以做出贡献.我将消化答案并将结果发回给我的客户,希望这可能对他们的任务有所帮助(我认为这有点远见,并且容易出现任何文档项目的所有陷阱,但仍然值得追求).

注意:问题不在于"我收集了有关IT资产的所有数据,而且我无法为Graphviz提供Visio或Google,也无法将其转换为MindMapping工具或使用Jgraph等创建自定义导航器." 问题是"如何收集相关/有用的信息,以及如何组织这些信息,考虑到由于接口,版本和软件包更改,我可能需要定期更新数据?"

这不是可视化问题,或者还没有.我们必须首先从数据收集和组织开始.如果您想建议一个工具,它还必须包括数据收集和管理部分(例如:Rational System Architect).但在这种情况下,如果您有一些实际经验,或者如果您非常确定它非常适合并且不太了解(我可以谷歌,谢谢),请提出建议.如果你想建议一些书籍/方法论,这也是有帮助的(我只知道Zachman框架,并且不确定它真的很合适).

"只需创建一个Excel文件"或"你可以使用SmartDraw,男人!!!" 恐怕没多大帮助.


找到了非常合适的Iteraplan!

mapping documentation resources enterprise assets

18
推荐指数
2
解决办法
2万
查看次数

我在哪里可以找到C++ 0x同步原语的良好,可靠的文档?

我已经看到了::std::thread等等的文章::std::forward,但我没有看过任何好文章::std::atomic.当然,还有标准提案文件,但我还没有看到任何想要使用该设施的人的良好文档.

有没有?我在哪里可以找到它?

c++ documentation multithreading memory-model c++11

18
推荐指数
2
解决办法
2483
查看次数

Struts 1的文档是否仍可在线获取?

我需要维护一个Struts 1应用程序.我知道,EOL差不多两年前,六年内没有新版本.无论如何,我们在Struts 1应用程序中拥有10万行工作代码,并且它不会因为我有更多现代感觉而消失.

我已经找了文档,所以我可以理解这个古老的框架,而且我是空的.这个链接坏了.如果您不计算EOL公告,此网站似乎只有Struts 2信息.

有没有人知道托管旧文档的网站?如果有人能指出Struts 1.2.7的文档,我将非常感激.

documentation struts struts-1

18
推荐指数
3
解决办法
9903
查看次数