To browse Academia. Skip to main content. Log In Sign Up. Anish Maharjan. Dipesh Shrestha Mr. This report is forwarded for examination to Pokhara University. Kamal Pd. Utsav Neupane. The material contained in the report has not been submitted to any University or Institution for the award of any degree.
Mandip Humagain Roll No: have completed the project work for the full prescribed period under Pokhara University curriculum and the project embodied the result of his investigations conducted during the period they worked as a full time student of this department. The Final year project has been approved by the following panel of examiners: S.
The satisfaction and success of completion of this task would be incomplete without heartfelt thanks to people whose constant guidance, support and encouragement made this work successful. On doing this undergraduate project we have been fortunate to have help, support and encouragement from many people we would like to acknowledge them for their cooperation.
Our first thanks goes to Pokhara University for designing such a worthy syllabus and making us do this project. Our next batch of thanks goes to the faculty of Management of Nobel College without whose help our project would have been impossible.
This list includes Principal of Nobel College, Mr. Dipesh Shrestha. Our very sincere and heartfelt thanks go to Mr. Utsav Neupane our project supervisors who constantly guided us through the project time period.
Without his guidance, our project would have been impossible. Last but not the least we want to thank every direct and indirect hands that were involved in completion of this project.Email: solutions altexsoft. Technical documentation in software engineering is the umbrella term that encompasses all written documents and materials dealing with software product development.
All software development products, whether created by a small team or a large corporation, require some related documentation. And different types of documents are created through the whole software development lifecycle SDLC. Documentation exists to explain product functionality, unify project-related information, and allow for discussing all significant questions arising between stakeholders and developers. Project documentation by stages and purpose. Consequently, managers should pay a lot of attention to documentation quality.
The documentation types that the team produces and its scope depending on the software development approach that was chosen. There are two main ones: agile and waterfall.
Each is unique in terms of accompanying documentation. The Waterfall approach is a linear method with distinct goals for each development phase. Teams that use waterfall spend a reasonable amount of time on product planning in the early stages of the project. They create an extensive overview of the main goals and objectives and plan what the working process will look like. Waterfall teams strive to create detailed documentation before any of the engineering stages begin.
Careful planning works well for projects with little to no changes in progress as it allows for precise budgeting and time estimates. The agile approach is based on teamwork, close collaboration with customers and stakeholders, flexibility, and ability to quickly respond to changes. The basic building blocks of agile development are iterations; each one of them includes planning, analysis, design, development, and testing. This allows for just-in-time planning. The main goal of effective documentation is to ensure that developers and stakeholders are headed in the same direction to accomplish the objectives of the project.
To achieve them, plenty of documentation types exist. Product documentation describes the product that is being developed and provides instructions on how to perform various tasks with it. In general, product documentation includes requirements, tech specifications, business logic, and manuals. There are two main types of product documentation:. Process documentation represents all documents produced during development and maintenance that describe… well, the process. The common examples of process-related documents are standards, project documentation, such as project plans, test schedules, reports, meeting notes, or even business correspondence.
The main difference between process and product documentation is that the first one record the process of development and the second one describes the product that is being developed. System documentation provides an overview of the system and helps engineers and stakeholders understand the underlying technology.
It usually consists of the requirements document, architecture design, source code, validation docs, verification and testing info, and a maintenance or help guide. A product requirement document or PRD provides information about system functionality. Generally, requirements are the statements of what a system should do. It contains business rules, user stories, use cases, etc. The best practice is to write a requirement document using a single, consistent template that all team members adhere to.
The one web-page form will help you keep the document concise and save the time spent on accessing the information. Technical documentation example: One web-page software requirements document created by using Atlassian Confluencethe content collaboration software. User experience design begins at the requirements stage and proceeds through all the stages of development, including the testing and post-release stages.
The process of UX design includes research, prototyping, usability testing, and the actual designing part, during which lots of documentation and deliverables are produced.
User Personas are created and documented during the research stage. The information gathered during user interviews and surveys is compiled into functional user persona documents.
User personas represent the key characteristics of real users, focusing on behavior, thought patterns, and motivation.These customized project management resources and templates will assist you throughout the lifecycle of a project. Formal project document defining scope, objectives and deliverables. The charter is your project's "contract," defining what you will accomplish, how you'll do it, and when it will be complete.
This document is available in:. Class 4 and 5 projects are not eligible to use the Slim Charter format. For Class 3 projects, please contact PMG before using this form. Formal document template for charging a project steering committee. Used to determine project size classification. Also included in the project proposal template. Flow chart of steps and resource to take a request from idea to an approved project. Standard template for regular status reports to keep project sponsors, teams, and constituents informed.
This a reference of tools that a business analyst may find useful when gathering requirements for a project. Formatted spreadsheet designed to track development features from proposal through release. Includes instructions. Supplemental Project Charter document for detailing proposed project expenses. Simple template used to identify and manage project communication needs. Formal project document used to describe and request approval for changes to project scope, time line or resources.
Standard template for defining the scope, resources, and time line for individual work packages within a project. This version is organized by the individual tasks within the work package. Recommended Template for managing project risks and issues for class 4 and 5 projects. Meeting agenda for the project team to identify risks and issues.
A project review provides an opportunity to step back and evaluate a project that is currently underway, often when a project experiences delays or is otherwise in trouble.
The Project Reviews is intended as a mechanism to help the Project Manager identify problem areas and create a plan to address them. Formal project document used at project close to evaluate and analyze lessons learned. This template is used as a project closure document. It documents recommendations from the project team to the ongoing service team for future work that needs to be done, but is out of scope for the project.Introduction: Documentation — seems to be a herculean task for a project manager.
Project managers are often engaged in delivering high-end complex projects. They are supposed to produce expected deliverables by encountering triple constraints in a project. Hence, the job of a project manager is always challenging with managing lots of activities. With this busy schedule, project manager seldom appreciates documentation part of project management. Reason being, project documentation is equally important for a good project manager. It can serve the purpose of providing proof of traceability or reference of something done.
In some or other way, project management helps project manager save her job. A project manager should be vigilant professional with an eye on tracking project progress. Sometimes, project documentation seems a burden to project management professional. But, a seasoned professional can understand the significance of good documentation.
She never undermines the use of documentation throughout a project cycle. Rather, she advocates the usage of good documentation templates. She tries to foster a culture of documenting and recording. Inadequate or no documentation increases the chances of project failure. Also, inadequate documentation can lead to the issues related to inadequate support in a project. Inexperienced project managers often struggle to understand, why is documentation important?
Documentation adds an anxiety to a greenhorn project manager. As she is supposed to deliver multiple projects within constraints. But, let me admonish you with not to skip documentation part at any cost for compensating your time challenges. Good time management is a much-required skill for a project manager. On the similar note, documentation is also equally important, if you want to hone project management skills. A good set of project management documents will certainly pay off in the end.
A project charter is an initial blueprint document in project management. Also, it helps to lay down a project plan to achieve deliverables. In fact, this document sets a direction for project manager and project team to sail through a project life cycle. As a project manager, you might work on multiple projects at one point in time.
Your job is to deliver all the projects at hand with desired expectations and benefits.
FREE 20+ Useful Sample Project Plan Templates in PDF | MS Word | Excel
To ensure that you are on track, you need to measure project deliverables against the project management plan. Hence, the project management plan is a significant part of your documentation throughout a project life cycle. But whom to communicate; when to communicate; and how - these are all conspicuous questions. An answer to these questions is — a well laid out communication plan. Project Scheduling is another document to help you navigate through a project by keeping the track of activities.
Technical Documentation in Software Development: Types, Best Practices, and Tools
And it also helps to make corrections, when needed. Being on schedule is a primitive requirement for a project manager. The major challenge with the project team is on how to start project work. Some of the projects are so complex that they may require the good amount of work and effort to complete. A work plan is another important consideration for a project manager.Many documents are created in the profession of project management.
Some of these are critical to the successful completion of the project, and others are merely intended for organizing the work flow. Bernie Roseke, P. As a bridge engineer and project manager, he manages projects ranging from small, local bridges to multi-million dollar projects. He is also the technical brains behind ProjectEngineerthe online project management system for engineers. He is a licensed professional engineer, certified project manager, and six sigma black belt. He lives in Lethbridge, Alberta, Canada, with his wife and two kids.
Hi Bernie, Thanks a lot for your doc list. This is very valuable for me.
Also, would it be possible that Process Group specific docs are missing within your Knowledge Area organized list? Regards FX.
Do take note that above is set up by a Knowledge Area and this is helpful when Setting up an Planning project documentation. Regards, Deyan. I have the 6th edition pmbok guide. But in my studying i dont see any of the documents. I really need to see and study these documents. How can i get hold of these documents. Your email address will not be published. Project Engineer has collaborated to provide the latest covid stats and prevention methods. Stay safe!
Check Real Time Updates. Subscibe to ProjectEngineer. NET channel — YouTube. Subscribe to ProjectEngineer. Project Engineer can send me occasional email updates about new site content.
The list is organized by knowledge area. This document initiates the project and authorizes the project manager. It documents the business need for the project as well as assumptions and constraints the project must live under. It generally includes high level scope and quality information.
It is issued by the project sponsor and represents the organizational authorization for the project. This is the project managers road map and guiding document. It is probably the single most important document for the project manager. It outlines how the project will be managed, and includes the project schedule, budget, quality standards, project team requirements, project control, and anything else that is necessary to communicate how the project will be managed.
It should be approved by the project sponsor and changes made according to the official change control procedures specified within.Let us help you chalk out that perfect project plan with some of our project plan templates that you can download for free. Preparing that perfect sketch of the project, its scope and all the actions that are to be taken with the project is what project planning usually consists of. We start off by making an introduction about the project and the plan that we are going to make.
The management of the project, the milestones that are to be met, the breakdown of work according to the milestones are all to be described in a very elaborate manner in the first part of the project plan. The changes, communications, costs, schedule and the quality of the project should all be managed well in order to execute the project with perfection. And the planning of all these is what the rest of the project plan will consist of.
The plan will then conclude with risk management plan and the final calendar according to which the staff is going to be working on the project.Software Requirement Specification SRS Document in hindi/urdu - SoftwareEngineering
We have got a few project plan templates that are sure to help you prepare just that perfect plan that you need. Download a sample project plan template for free and use it for your project to make sure that just about any project you take up is a humongous success. If you have any DMCA issues on this post, please contact us!Projects can vary in size, deliverables, life cycle, scope and that is just the tip of the variable iceberg. What is certain is that project documentation should be clear, relevant and up to date.
This will ensure all project stakeholders are on the same page at the same time.
Expectations, requirements, resources, and risks should be obvious to all from the outset. I recently asked some of my wider community for tips on project documentation and I have summarized my findings in the blog post below.
Prior to kicking off the gathering or developing of project documentation, it is important you first have an understanding of why the project is happening and what type of governance the project may require. This will determine how much and what type of project documentation is required and whether you need to gather project documentation or start developing it from scratch.
Once you have the answer to some of these questions you can then begin to gather and develop the project documents you may need to be successful with your project. This document will provide the justification for investing in the project. It is really the kick-off document that explains why the project is taking place; the goals, objectives, and outcomes being sought.
This document could be a simple email from a client or a page word document that has input from 10 project stakeholders. Typically, the project sponsor is responsible for developing the business case, which can include an economic feasibility study. The project charter formally authorizes the project whilst giving the project manager the authority to plan, execute, and manage the project.
The Matrix charts who is R esponsible, who is A ccountable, who is C onsulted, and who should be I nformed for each task. A work breakdown structure is the core of project planning, resource management and helps to prevent project scope creep. The WBS is used to organize the work into manageable sections, often measured in time, for example, two weeks. The list starts with the required deliverables. This goal is further broken down into work packages and tasks needed to reach this objective.
By focusing on the bigger picture, the WBS ensures that no element of the project is overlooked during the planning phase. This is exactly what it says on the tin — a log of all risks and issues the project may face. It is good practice to follow some sort of logging format; name or ID, description, impact, probability, proposed mitigation and owner or person accountable.
This will ensure effective communications amongst the project team and stakeholders. Other, more complex projects require email and document policies; status meetings and automated status reporting; work, status, risks, and issues. This will help keep track of any formal additions or alterations to the agreed-upon deliverables from any of the other project documents.
Change management is challenging as project managers need to ensure that the change is sufficiently detailed and understood by all parties.
The project schedule determines what work needs to be done and when. It is the timeframe for completing tasks and starting others. In some cases, it is a good idea to document the planned schedule and the current schedule so that late tasks can be flagged and properly addressed.
There are tools available to do this in an automated way, including BrightWork Simple Scheduling for light scheduling needs and Microsoft Project for heavy scheduling needs.