Project Reports
Contents
1. use of special components commercial or military versions component details etc m Information Sources And References m Glossary Of Terms CSE UTA 9 SYSTEM REQUIREMENTS SPECIFICATION EVALUATION PROJECT 1 1 Production Definition 1 2 Project Solution strategy 1 3 Risk As amp asemant 1 4 Product Features Evolution 1 6 Qualification Test Criteria 1 6 Final Version Accept Grit o l ores ove wr em 4 INFORMATION SOURCES amp REFERENCES C SEE BACK OF SHEET FOR COMMENTS PROJECT PLAN EVALUATION 1 2 Project Team Description 1 3 Project Team Management zome fe EE 4 TASK DESCRIPTION ASSIGNMENT EN O Errors ao Peneounepresounces am EEC vanme o ASSIGNED WEIGHTED GRADE O SEE BACK DF SHEET FOR COMMENTS CSE UTA TECHNICAL REPORTS Preparation gt Who will be reading it gt What do they need to know gt What organization of the report will best present the material gt Synthetic or analytic for main body Outline gt Use a TOP DOWN development approach Introduce The Report gt Prior to the main body gt Orient the reader thoroughly gt Explain the purpose and basic nature of the report gt Provide an easily read summary overview Details to come later Use Headings and Subheadings Use Appendices gt Put detailed material in them that may obscure important ideas or data Concentrate on Results More T2. but or nor for yet m Right James ran the movie projector but he did not know how to splice film s Wrong James ran the movie projector and spliced film After long introductory phrases and clauses m Right Even though we had bought the television set used and had it for three years the company repaired it for their cost m Wrong When Mary left he cried for two hours With words phrases and clauses in series m Right The letter asked the students to send name address sex and housing requirements m Wrong The letter asked the students to send name address sex and housing requirements To set off nonrestrictive elements clauses phrases appositives m Right Mr James McCrimmon who just took his place on the jury teaches Latin at the academy m Right Mr James McCrimmon who just took his place on the jury teaches Latin at the academy CSE UTA CSE UTA GRAMMAR AND PUNCTUATION A SHORT GUIDE Cont m The Semicolon gt The semicolon is used as follows Between two independent clauses not joined by and but or nor for yet m Right James graduated from high school he attended college in Charleston s Wrong James graduated from high school he attended college in Charleston Between two independent clauses joined by a conjunctive adverb however moreover consequently nevertheless and such words m Right Mistakes were made in calculations nevertheless we were given the
3. contract m Wrong Mistakes were made in calculations nevertheless we were given the contract 21 CSE UTA GRAMMAR AND PUNCTUATION A SHORT GUIDE Cont m The Colon gt The colon is used as follows Itis used to introduce a long formal list Be sure to use a complete sentence before the colon m Right The following men will report to the headquarters as soon as possible m Wrong Our reasons for refusing the contract are m The Apostrophe gt The apostrophe is used to form possessives and to indicate contractions Right It s all right with me if you change your plans Wrong The cat caught it s tail in the trap Right The cat caught its tail in the trap gt The possessive of personal pronouns has no apostrophe 22 CSE UTA TECHNICAL DOCUMENTATION STANDARDS m Software Documentation gt Internal Documentation Compilation unit prologues Source code Embedded comments gt Program Unit Notebooks gt Supporting Documentation Requirements specification Design Specifications Test Plans User s Manuals Installation Instructions Maintenance Reports 23 CSE UTA TECHNICAL DOCUMENTATION STANDARDS m Subprogram And Compilation Unit Prologues gt Date of compilation gt Name of the Author gt Function s performed gt Algorithms used gt Author date purpose of modifications gt Parameters and modes gt Input ass
4. Notes On Requirements Development m Requirements specification should be gt Correct gt Complete gt Consistent gt Unambiguous gt Derived from functional decomposition therefore traceable gt Verifiable gt Easily changed CSE UTA 1 Notes On Requirements Development m System Level gt Steps necessary Identify problem s from a study of the customer user requirements Develop and analyze scenarios Define the problems in terms of what operational requirements must be satisfied or what objectives must be accomplished It is often necessary to study many areas before the problem is well understood and practical solutions can be examined This system analysis then results in and supports the alternate solution strategies Select and justify a solution approach strategy Conceptually define system which solves the problem Operational functions m Technical requirements m Hardware software system architecture Generate the system requirements specification CSE UTA Notes On Requirements Development m System Level gt Typical Considerations Application problem statement External interfaces and dataflows Product feature User environment Acceptance criteria Scenarios Use of rapid prototyping Project plans gt Requirements Description A natural language e g English Formal languages CSE UTA Notes On Requireme
5. ent gt Make your verb agree with its subject This problem occurs most often when a subject and verb have intervening words Wrong A list of absent members are attached Right A list of absent members is attached gt Make your pronouns agree with their antecedents In the above sentence their correctly agrees with the word pronouns Wrong Everyone in the class raise their hand Right Everyone in the class raise his hand 15 CSE UTA GRAMMAR AND PUNCTUATION A SHORT GUIDE Cont m Agreement gt Use the nominative case for subjects the objective for objects Wrong Dr Thompson enjoys teaching the computer to whomever wants to learn Right Dr Thompson enjoys teaching the computer to whoever wants to learn In this sentence whoever is the subject of the verb not the object of the preposition to Wrong The task was divided between he and Greg Right The task was divided between him and Greg In this sentence both him and Greg are objects of the preposition between m Ambiguity gt This word refers to double meaning or vagueness Wrong John told James that Bill didn t like him Right John said to Jim Bill doesn t like me 16 CSE UTA GRAMMAR AND PUNCTUATION A SHORT GUIDE Cont m Capitalization gt Capitalize the proper nouns the first word of every sentence the first word of each item in the outline the f
6. ertions gt Output assertions gt Global variables gt Side effects gt Major data structures gt Calling routines gt Called routines gt Timing constraints gt Exception handling gt Assumptions 24 CSE UTA TECHNICAL DOCUMENTATION STANDARDS Commenting Conventions gt Minimize the need for embedded comments by using the standard prologues structured programming good style descriptive names etc Attach comments to block of code Y Y Use problem domain terminology Y Place to far right Y Do not use long involved comments Y Be sure that comments code and specifications agree m Hardware Documentation Internal Documentation Labels on packages PC boards connectors chassis etc Color coded wires parts etc 25 TECHNICAL DOCUMENTATION STANDARDS gt Laboratory notebooks gt Supporting Documentation Requirements specification Design specifications Test plans Wiring lists Pin outs Schematics PC board artwork Physical Layouts Mechanical details Packaging design User s manual Installation instructions Maintenance reports CSE UTA CSE UTA TECHNICAL DOCUMENTATION STANDARDS m Laboratory Notebook gt Date gt Engineer s name gt Technician s name gt Diagrams circuit logic system mechanical etc gt Explanation of circuits etc gt Test plans gt Test results prin
7. fication Report m Qualification Test Criteria gt Rapid prototype gt Pilot model gt Final Version Acceptance Criteria m Software Requirement gt Environment Definition Development Operating Maintenance gt External Interfaces and Dataflow gt Functional Requirements gt Performance Requirements gt Exception Conditions And Exception Handling gt Implementation Priorities gt Acceptance Criteria Functional Tests Performance tests Documentation standards Design Guidelines CSE UTA 7 System Requirements Specification Report m Hardware Requirement gt Environment Definition Temperature humidity acceleration shock dust electromagnetic interference electrical power line noise harmonics etc Development Operating Maintenance Storage and Shipping External Interfaces Digital Analog Y I O Devices special connectors subsystems etc Y Functional Requirements Y Performance Requirements Y Electrical Requirements Power limits EMI generation limit CSE UTA 8 System Requirements Specification Report gt Physical Requirements Maximum weight Maximum volume Maximum envelope gt Implementation Priorities gt Acceptance Criteria Functional tests Performance tests Electrical tests Physical tests Test environment Documentation standards Design Guidelines
8. han Methods Provide A Table Of Contents 12 Written Communication e As an engineer you will write Lab reports Letters Memos Proposals Progress reports Formal Reports You need to be able to write Clearly and Concisely e Professional advancement depends Heavily On Your Writing Ability Preparation For Writing Determine your objectives Determine the reader s objectives Select the proper format Identify any constraints Setthe proper tone Tutoring and explanations Proposing Presenting results For the record CSE UTA CSE UTA Written Communication m Internal Communications Notes Brief unstructured communications between two persons where file copies are NOT needed One page max L han r SER daam al woude The method depends on the Can be hand written importance of communication E Mail and phone calls gt Memos More formal than a note but less formal than a letter or report Communications between members of the same organization When a file copy is necessary 14 CSE UTA GRAMMAR AND PUNCTUATION A SHORT GUIDE m Abbreviations gt Abbreviations are widely used in technical writing Be sure however that they will be understood by your readers When in doubt spell the complete word Avoid using etc in formal writing since readers may not know what you are including m Agreem
9. irst and every important word in titles of books magazines newspapers gt Do not capitalize points of the compass the seasons the names of academic studies unless they are specific courses Philosophy 306 psychology engineering mathematics E Choppy Sentences gt Too many short sentences can cause problems because they are monotonous to read and because the writer makes the reader determine how many choppy sentences are related The tendency to write a choppy style is sometimes referred to as the Dick and Jane syndrome or the Jack Webb Dragnet syndrome Use an occasional short sentence for emphasis m Coherence gt Make your ideas stick together by logical development and by using transitional words carefully These words can come within sentences as well between them However moreover consequently as a result nevertheless first seconds are examples 17 CSE UTA GRAMMAR AND PUNCTUATION A SHORT GUIDE Cont m Dangling Modifiers gt Opening verbal or prepositional phrases will appear to modify the first noun or pronoun following them Be sure it is the right word Wrong Having rear end trouble I was driving slowly down the highway Right Because my 1978 Plymouth was having rear end trouble I was driving slowly down the highway m Fragments gt Do not punctuate subordinate clauses or phrases as if they were sentences Wrong While the machine was out order Right While the machine
10. nts Development m Software Requirement gt Translate system into software requirements Scenarios can permit requirement clustering and meaningful incremental development gt Specify functional requirements Implicit equations Recurrence relations Algebraic axioms Regular expressions Decision tables Petri Nets Flowcharts Dataflow graphs CSE UTA Notes On Requirements Development m Hardware Requirements gt Translate system into hardware requirements Scenario driven decomposition of hardware functions support development gt Typical types of requirements Reliability performance electrical thermal physical m Requirements Specification Languages And Systems Hardware oriented CDL DD PMS ISPS AHPL VHDL Software oriented PSL PSA RSL REVS CSE UTA System Requirements Specification Report E m System Level Requirements gt Product Definition Problem statement Functions to be performed External interfaces Summary of operating environment User characteristics gt Project Solution Strategy Criteria to compare solution merit Selected approach Evaluation of Alternate approaches considered gt Risk assessment Design feasibility areas of concern Implementation feasibility areas of concern gt Product Features Evolution Rapid prototype Pilot model Final version CSE UTA 6 System Requirements Speci
11. touts photos plots tables etc gt Instruments used during test m Contractual Documents gt Statement of work gt Budget gt Deliverables gt Schedule 27
12. was out order production was down by six percent m Paragraphs gt Every paragraph should have a topic sentence usually the first one The other sentences should stick to the topic and develop the main idea by details examples logical argument comparison and contrast Paragraph unity means that all sentences help develop one idea 18 CSE UTA GRAMMAR AND PUNCTUATION A SHORT GUIDE Cont m Passive Voice gt Use the passive voice when the doer of action is unknown unimportant or not to be mentioned for some reason Laboratory reports are correctly written in the passive voice Active I heated the liquid to 100 degrees centigrade Passive The liquid was heated to 100 degrees centigrade gt Use the active voice to emphasize the doer of the action Passive It is recommended by the architect that steel be reinforced concrete be used Active The architect recommends that steel reinforced concrete be used m Punctuation Punctuation properly used helps you say what you mean to say Improperly used it slows down communication and at times stops it Learn to punctuate by rule not by intuition Do not over punctuate Overuse of comma is a big offender 19 GRAMMAR AND PUNCTUATION A SHORT GUIDE Cont m Thecomma gt The comma is used in the following ways Between two independent clauses complete sentences when they are joined by a coordinating conjunction and
Download Pdf Manuals
Related Search