Posts

Showing posts from 2002

Project Documentation Guideline

Acknowledgement References Main modules are: Introduction (Abstract For Terms Of Reference) Project Introduction Project Background or History Problem statement Feasibility Study Economic Technical Social System analysis (Abstract for RS document) Research of current Procedures and techniques Investigation Fact Finding Observation Reading Documents Asking staff Questionnaires Interviews Drawback/weaknesses of current Techniques Possible Solutions (All the possible solutions even manual if any) Proposed Solutions Specific objectives of my solution Constraints Timescale Or Timelines System Design (Abstract For FS Functional Specification ) Hardware/ software Options (Hardware and Software needs) Proposed Hardware/ software solution (Tools used and there WHY factor) Cost and benefit analysis (for the above) System Design and Flow Diagrams (System flow, DFD’s, UML (proposed)) also involves the

Project Documentation Standards

Introduction This documentation standard will be used during a one-semester software engineering course. The standard suggests common content for each phase of the development process. The use of this standard is a guideline rather than a law . Each team will adapt the suggested content of each document to their specific situation. Software Requirements Specification (SRS) Audience and goals of SRS The requirements specification has two distinct audiences: The client and the technical personnel who will be designing the product. The SRS has several goals: establish grounds for agreement among the key players as to what problem is to be solved by the software define a baseline for the remaining technical activities, such as design, implemenatation, testing, and maintenance give a basis for traceability of the requirements through the lifecycle provide a baseline that management can use in guiding the development process Preliminary SRS vs. Final SRS Often, the