tag:blogger.com,1999:blog-24571271858257800352024-08-30T10:04:02.763-05:00Document GuyThis blog is dedicated to provide guidance on documentation and also to discuss if a single standard template approach works for all types of customers and projects or each project and customer need a different document templates/standards.Unknownnoreply@blogger.comBlogger3125tag:blogger.com,1999:blog-2457127185825780035.post-49972172902136785902010-01-17T16:57:00.001-06:002010-02-09T09:34:13.112-06:00Project Charter<div style="text-align: justify;"><span style="font-family: Georgia, "Times New Roman", serif;"><span style="font-size: small;">Project charter document is the first document that is created to start the project. Project Charter development is a pre-Project effort. Project Charter has high level details about the project like initial definition of the scope of the project based on the concerns and requirements of the stakeholders [in the Stakeholder Register]. This scope may be altered at a later stage of course by going through the Change Request Process. Project Charter also provides an initial financial commitment from the Project Sponsors based on the estimates provided or based on a similar project in past. Following items form a typical project charter document:</span> </span></div><ol><li><span style="color: #29303b; font-family: Georgia, "Times New Roman", serif; font-size: 13px;"> Title</span></li>
<li><span style="font-family: Georgia, "Times New Roman", serif;">Header [Project Name, Project Number, Section/Chapter Name]</span></li>
<li><span style="font-family: Georgia, "Times New Roman", serif;">Footer [Page numbers </span><current><span style="font-family: Georgia, "Times New Roman", serif;">of </span><number><span style="font-family: Georgia, "Times New Roman", serif;">]</span></number></current></li>
<li><span style="font-family: Georgia, "Times New Roman", serif;">Version / Author Details</span></li>
<li><span style="font-family: Georgia, "Times New Roman", serif;">Table Of Contents</span></li>
<li><span style="font-family: Georgia, "Times New Roman", serif;">Index for Pictures/Figures</span></li>
<li><span style="font-family: Georgia, "Times New Roman", serif;">Executive / Short Summary</span></li>
<li><span style="font-family: Georgia, "Times New Roman", serif;">Overview</span></li>
<li><span style="font-family: Georgia, "Times New Roman", serif;">Scope of the project</span></li>
<li><span style="font-family: Georgia, "Times New Roman", serif;">Financial Commitment</span></li>
<li><span style="font-family: Georgia, "Times New Roman", serif;">Stakeholders</span></li>
<li><span style="font-family: Georgia, "Times New Roman", serif;">Glossary</span></li>
<li><span style="font-family: Georgia, "Times New Roman", serif;">Appendices</span></li>
</ol>Unknownnoreply@blogger.com0tag:blogger.com,1999:blog-2457127185825780035.post-51405118109406044502009-11-13T13:28:00.002-06:002010-01-17T16:55:15.915-06:00Common Sections in All Documents<div style="text-align: justify;">Before I start discussing each document, lets first look at some commonalities related to all documents.<br />
</div><div><ol><li style="text-align: justify;">Title</li>
<li style="text-align: justify;">Header [Project Name, Project Number, Section/Chapter Name]</li>
<li style="text-align: justify;">Footer [Page numbers <current> of <number> ]</number></current></li>
<li style="text-align: justify;">Version / Author Details</li>
<li style="text-align: justify;">Table Of Contents</li>
<li style="text-align: justify;">Index for Pictures/Figures</li>
<li style="text-align: justify;">Executive / Short Summary</li>
<li style="text-align: justify;">Glossary</li>
<li style="text-align: justify;">Appendices</li>
</ol><div style="text-align: justify;">These sections will be in almost all the documents. Sections above are important for the structure of document, so that when printed it provides detailed information to the user without going back and forth between the pages.<br />
</div></div><div><div style="text-align: justify;"><br />
</div></div><div><div style="text-align: justify;">Now that we have formed a base, in my next post we'll look at each of the documents listed in my earlier <a href="http://bestofdotnet.blogspot.com/2008/01/functional-requirements.html#links">post </a><br />
</div></div><div><div style="text-align: justify;"><br />
</div></div>Unknownnoreply@blogger.com0tag:blogger.com,1999:blog-2457127185825780035.post-11782965458559990872008-01-07T10:12:00.002-06:002010-01-17T16:56:01.389-06:00Types Of Documents Used For Software Development<div style="text-align: justify;">Lets see how many different types of documents are required for software development. I am listing some of the documents which I have come across and would like others to add to the list. Some of the documents listed may overlap each other but I have still listed them.<br />
</div><ol><li style="text-align: justify;">Project Charter</li>
<li style="text-align: justify;">Project Scope</li>
<li style="text-align: justify;">Request For Proposal [in case of offshoring or outsourcing]</li>
<li style="text-align: justify;">Proposal Document [in case of offshoring or outsourcing]</li>
<li style="text-align: justify;">Systems Requirement Specifications</li>
<li style="text-align: justify;">Functional Specifications</li>
<li style="text-align: justify;">Systems Architecture Document</li>
<li style="text-align: justify;">High Level Design</li>
<li style="text-align: justify;">Low Level / Detail Design</li>
<li style="text-align: justify;">Unit Test Plan</li>
<li style="text-align: justify;">Unit Test Cases</li>
<li style="text-align: justify;">Integration Test Plan</li>
<li style="text-align: justify;">Integration Test Cases</li>
<li style="text-align: justify;">System Test Plan</li>
<li style="text-align: justify;">System Test Cases</li>
<li style="text-align: justify;">User Acceptance Test Plan</li>
<li style="text-align: justify;">User Acceptance Test Cases</li>
<li style="text-align: justify;">Deployment Document</li>
<li style="text-align: justify;">User Manual / Help</li>
<li style="text-align: justify;">FAQs</li>
<li style="text-align: justify;">Help Desk Manual</li>
<li style="text-align: justify;">Operations Manual</li>
</ol><div style="text-align: justify;">My plan is to discuss these in coming weeks and also have examples on each one of them.<br />
</div>Unknownnoreply@blogger.com0