软件产品的内部开发文档 [英] Internal development documentation for software product

问题描述

你好开发者，



我希望你做得很好。

我为我的组织创建了一个软件产品，现在我想要创建内部开发文档。文档应该解释每一个和所有内容，包括系统的工作流程和编码。

目的是开发一个文档，帮助非技术和技术用户，以便它可以帮助他们理解产品的细节。

该文件还应该帮助技术支持团队或任何新开发人员理解产品背后的逻辑和代码。

产品是使用ASP.NET和MS-SQL开发的。

如果你可以在这方面帮助我，或者给出一些已经创建的文档的例子，我会很高兴，因为我之前没有制作任何文档，我想要创造一个最好的。



非常感谢。



我尝试过：



搜索有关文档的网页，但我找不到任何示例文档。

Hello developers,

I hope you are doing great.
I have created a Software Product for my organization and now i want to create a 'Internal Development Document'. The documentation should explain each and everything including the workflow of the system as well as the coding.
The aim is to develop a document that will help both non-technical and technical users so that it can help them in understanding the nitty gritties of the product.
The document should also help the technical support team or any new developer in understanding the logic and code behind the product.
The product is developed using ASP.NET and MS-SQL.
I would be greatful if you can help me in this regard or give some examples of already created documents as i have not made any document before and i want to create a best one.

Thanks a ton.

What I have tried:

Searching the web regarding the documentation, but i am unable to find any sample document.

推荐答案

当你开始编写代码时，你可以使用GhostDoc做某事。

它可以帮助您生成程序文档。

you can use GhostDoc to do something,when you start writing code.
It can help you generate program documentation.

这篇关于软件产品的内部开发文档的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！