我需要为我刚刚开发的Asp.Net网站编写技术文档。它应该包括什么？ [英] I Need To Write technical document For My Asp.Net Website I Just Developed. What Should It Include?

问题描述

请任何人都可以帮助我，因为我需要为我最近开发的asp.net网站编写技术文档。



我想知道应该做些什么它包括屏幕，数据库设计，课程或其他什么？



提前谢谢。

Please any one can help me as i need to write a technical document for my recently developed asp.net website.

I would like to know what things should it include like screens, DB designs, classes or what else?

Thanks in advance.

推荐答案

寻找在您的组织中使用的技术设计模板。它通常是适合您自己组织的标准模板。



如果您没有，请查看Google的示例。



https://www.google.nl/search?q=technical+design+template&sourceid=ie7&rls=com。 microsoft：en-US：IE-SearchBox& ie =& oe =& gfe_rd = cr& ei = NtphVKbHHMyZOoS2gIgE& gws_rd = ssl [ ^ ]



第一个本身就是好的开始：



http://www.google.nl/url?sa=t&rct=j&q=&esrc=s&source=web&cd=1& ; CAD = RJA&安培; uact = 8&安培; VED = 0CCwQFjAA&安培; URL = HTTP％3A％2F％2Fwww.it.northwestern.edu％2Fbin％2Fdocs％2Fproject-框架％2FDetailed_Technical_Design_Template_v061511.docx&安培; EI = NtphVJiNKoPVPLLEgNAB&安培; USG = AFQjCNFQT2KuSnX4MEVYKCqbk7R99uB_-W&安培; sig2 = ULuHUgvJkd5-p-o9T7hYzg& bvm = bv.79189006，d.ZWU [ ^ ]

Look for a technical design template which is used in your organization. It usually is a standard template suited to your own organization.

If you don't have one, look at Google for examples.

https://www.google.nl/search?q=technical+design+template&sourceid=ie7&rls=com.microsoft:en-US:IE-SearchBox&ie=&oe=&gfe_rd=cr&ei=NtphVKbHHMyZOoS2gIgE&gws_rd=ssl[^]

The first one itself is good one to start with:

http://www.google.nl/url?sa=t&rct=j&q=&esrc=s&source=web&cd=1&cad=rja&uact=8&ved=0CCwQFjAA&url=http%3A%2F%2Fwww.it.northwestern.edu%2Fbin%2Fdocs%2Fproject-framework%2FDetailed_Technical_Design_Template_v061511.docx&ei=NtphVJiNKoPVPLLEgNAB&usg=AFQjCNFQT2KuSnX4MEVYKCqbk7R99uB_-w&sig2=ULuHUgvJkd5-p-o9T7hYzg&bvm=bv.79189006,d.ZWU[^]

嗯.. 。所有相关的东西。



如果你因为最初的开发人员在公共汽车下面而拖入维护或更改网站，想想你想知道什么。这意味着忘记您所知道的内容并从新的开发人员角度看待该网站。它是如何工作的？事情在哪里？它是如何组织的？代码如何工作？你采取了什么捷径？那有多奇怪？



想想你想从别人那里看到什么来让你的生活更轻松，并记录下来！

Well...everything relevant.

Think about what you would want to know if you were dragging in to maintain or change the site because the original developer fell under a bus. Which means to forget what you know and look at the site from a new developer perspective. How does it work? Where are things? How is it organised? How does the code work? What shortcuts did you take? What oddities are there?

Think about what you'd want to see from someone else to make your life easier, and document that!

1 。您的网站要求能够运行它。

例如.Net Framework版本，IIS版本等，数据库相关等。



2.配置你运行它。

3.保存代码的地方，网站的起始页是什么。

4.技术术语中每页逻辑的描述。

5.列出你的表格，存储过程。



还要经常更新问题和修复方法。

1. You website requirement to be able to ran it.
e.g. .Net Framework version, IIS version etc, DB related etc.

2. Configuration you made it to ran it.
3. Where the code is kept, What is start page for you websites.
4. A description on each pages logic in technical terms.
5. List you tables , Stored procedures.

Also keep on updating frequently issue faced and way to fixed.

这篇关于我需要为我刚刚开发的Asp.Net网站编写技术文档。它应该包括什么？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！