Questions tagged «documentation»

软件文档是计算机软件随附的书面文本。它说明了该软件如何运行,如何安装,如何使用它以及其他寻求帮助的资源。

7
专业软件开发团队如何处理非平凡项目中的设计复杂性?
首先,我意识到这个问题可能会有些冗长和含糊,为此我深表歉意。对于任何“了解它”的人来说,这可能是一个简短的基本问题,但由于我发现自己在这方面缺乏经验,因此请在描述问题时请多多包涵。 从我11岁左右开始,我就一直以这种方式进行编程。这意味着我从一开始就一直在教自己。我接受了技术教育,但并非严格地学习计算机科学(我获得了光子工程学学位)。我们当然有编程课程,但这对我来说基本上是基本的东西,我没有学到很多新东西。我一直在为自己的快乐而进行自我教育,并且一直知道自己会从事编程事业,但是那时我的所有项目都还很小。我毫不费力地将它们牢记在心并加以维护。 现在,我发现自己是团队的领导者,而不是公司环境的领导者-我在大学工作,开发用于工程应用的科学软件(C ++)。突然间,这个项目正在(相对)变大,而且我大部分时间都无法解决这个问题。我主要在两件事上浪费了很多时间和精力: 当我不得不返回一段时间未使用的代码时,我很难记住它是如何工作的。我花了很多时间来查看相关类的头文件,并阅读在源文件中放置的注释。我希望我可以瞥见某种形式的“示意图”并更轻松地重获图片。 当我引入更改时,有时我会中途意识到,我试图做的事情会破坏其他地方的功能(或更糟糕的是,它只会在运行时显示出来,这是一个惊喜)。我还原并开始以不同的方式进行操作,结果发现我忽略了对其他组件的影响。我希望有一些“架构图”,在其中可以看到事情的完成方式,我要尝试做的事情将如何影响其他组件,以及为我提供一种在开始实施更改之前进行详细规划的方法。 与我一起工作的大多数人都有与我自己相似的故事-较强的技术导向,有时甚至是高超的技巧,但无法组织工作。但是,他们的项目通常比我的项目小得多,所以他们可以应付。无论如何,这对我来说意味着我一个人,没有人可以学习良好的做法。 我修了一个管理IT的研究生课程,尽管我觉得它很令人满意,但它主要针对非程序员,有关项目管理方法论,预算/进度估计,企业体系结构的教学,而不是软件设计和规划。没关系,我也在尝试学习这些东西。当然,引入了一些工具(例如UML)和软件开发过程的类型(级联,迭代,敏捷...),但是显然没有详细介绍,我很难决定我应该选择和使用的东西(以及达到什么程度)。 我一直在阅读有关SO上软件设计的许多问题和答案-有很多关于使用这种工具或特定工具或方法进行设计的问题,并且如果我确信UML文档可以解决我的问题-我会选择并开始使用它。但是有些人发誓,其他人则说它没用。我正在寻找更高层次的抽象的答案-有解决我所遇到的两个问题的方法吗,您个人怎么做?我应该学会什么才能做到这一点,而不必局限于某个特定工具?这些有时会变得过时,我希望它们的适用性会因项目类型而异。 非常感谢您的阅读,我无法简要地说出我的意思(缺乏软件设计经验和词汇)。

3
文学编程与语义网之间有什么联系?
当我偶然发现这个宝石时,我(通常)在研究基于语义/本体的技术文档方法: 文字编程和语义网是来自不同时期的思想,它们之间确实存在联系。 链接的论文Norman Walsh 撰写的XML Literate Programming in XML讨论了语义Web的核心技术,但是我看不到识字编程与基于语义Web 或基于本体的文档之间的概念联系。帮帮我?

3
如何记录必然复杂的代码结构?
如果我的一段代码在数学或结构上相当复杂且不可简化,那么我将如何记录这段代码?特别是,如何确保可能没有我本人的数学或建筑技能的人可以从文档中理解?我也应该记录所有数学吗?链接到教程?在复杂结构的情况下是否进行一些视觉辅助链接?

7
我如何记录别人的过去工作?[关闭]
已关闭。这个问题需要更加集中。它当前不接受答案。 想改善这个问题吗?更新问题,使其仅通过编辑此帖子来关注一个问题。 4年前关闭。 我们处于一种糟糕的境地,因为过去的工作人员对关键业务系统所做的定制文档很少。对我们的ERP软件的Crystal Reports,数据库实体和专有配置/编程文件进行了许多更改。 当前文档通常读取如下内容: 该程序在开具发票之前运行。已知错误:无。 安装软件X后运行此程序。 更改了此报告中的以下字段:(未解释如何或为什么) 我们的IT部门很小,就ERP软件而言,大多数工作都集中在一个人上(现在就是我),所以这里没有其他人知道我们所做的一切。IT和会计部门了解点点滴滴(有时很有帮助),但这还不够。 另一个问题是我们的会计部门似乎认为我们有据可查。的确,我们保留了很多错误记录,但很少有解释(如果有的话)解决这些问题的方法。我们有数百篇论文解释错误,但是解释更改的文档(如上所示)几乎没有用。 当我不知道所做的全部工作时,如何记录过去的更改?我可以先记录一下我们所做的更改:文件,数据库表等等,这些是系统正常运行所必需的。我还可以记录我们做的 ; 运行报表时,为什么要告诉人们使用X报表/程序。但是当这些定制的东西之一出现问题时,我总是回到正题。 我如何主动为自己和他人记录这些内容?


5
在开发之前对现代应用程序建模的标准是什么?
我正在处理我的第一个企业级应用程序,我希望我的团队在提取代码之前就对整个ASP.NET MVC C#应用程序进行建模。 更新:这并不是要对何时记录/建模应用程序进行哲学上的讨论。请仅提供有关“如何”文档/模型的答案。 事实是,我一直在这个部门中工作过,而且从未真正建模过应用程序。这样做的标准方法是什么?应该使用哪种类型的图表以及文档外观如何?链接到示例图和文档表示赞赏。 在搜索时,我可以在网上找到很多东西,但是我想看看是否存在关于如何执行此操作的现代共识。 提前致谢! 结束语 我不知道这是一个棘手的话题。谢谢所有能够抛弃明显争议并提供有用答案的人。至少可以说这是一个有趣的讨论:) 我发现的另一个有用链接是:https : //stackoverflow.com/questions/61487/do-you-use-uml-in-agile-development-practices/61519#61519

4
您放在影响分析文档上的内容是什么?
因此,您要修复错误,然后遇到一个可能会影响软件产品其他模块的错误。您的数据不足以支持您对修复效果的主张,因此您被要求创建影响分析文档。 是否有明确的流程来做到这一点? 需要哪些关键信息? 该文档有任何已知的格式/模板吗?

3
使用维基来满足需求
我正在研究改善需求管理的方法。当前,我们在网站上发布了Word文档。不幸的是,(据我所知)我们无法查看从一个修订版到下一个修订版的更改。我非常希望能够做到这一点,就像使用Wiki或VCS(或两者,就像Wiki在bitbucket上一样!)。 而且,每个文档都描述了开发人员在给定的截止日期之前预期会遇到的变更。在任何地方都没有记录到的累积应用程序功能集合,因此,在尝试快速修复旧版应用程序时,有时很难区分错误和(设计不良)功能。 所以我有一个想法想要得到反馈。关于什么: 使用Wiki,以便我们可以跟踪谁更改了什么时间(主要是查看自上次查看以来是否进行了任何编辑)。 每个产品只有一个Wiki页面,而不是每个截止日期只有一个Wiki页面,以跟上产品的所有功能,而不是应实施的更改。这样,我可以查看页面的特定版本,以查看应用程序在给定时间点应执行的操作,并且可以查看 自上次发布以来对页面的更改,以在下一个截止日期之前实现要求。 Waddayathink?

7
注释/代码内文档样式
这可能是一个愚蠢的问题,但是已经出现了一段时间,在其他任何地方都找不到合适的答案。 我有一位老师说,即使只有一个,我们也应该明确列出每个参数的描述。这导致很多重复: double MyFunction(const int MyParam); // Function: MyFunction // Summary: Does stuff with MyParam. // Input: int MyParam - The number to do stuff with. // Output: MyParam with stuff done to it. 在编写代码文档时,您有多详细?
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.