FIT2043 Lecture Notes - Lecture 2: Software Development Process, Gantt Chart, Spell Checker
13 Jun 2018
School
Department
Course
Professor
L2 - Writing tips
Bad Writing
●Writing too much ( Verbosity ) - be concise!
●Using words that you are not sure of
○Fix - when modelling domain have a doc in which the terms being used
in the project is defined so that everyone in the team knows how to use
●Agency : Language that avoids active verbs (aka passive voice, bad because
it sounds evasive)
○Eg. punches were thrown at the meeting
●Vacuousness: Using phrases that are complicated and actually mean
nothing
●Nerdview : failing to see how others see the world
Good Writing Tips
●Plan first before writing
●Quality Assurance
○Proof read
●Use spell checker
●Style
○Be consistent with fonts and layout
●Do executive summaries where necessary (long documents)
L3 - Register & Tone
Register - Refers to the ways that language changes depending on the situation
●Tenor - Level of formality
○ Varies according to the relationship between the participants
○ written or spoken? written and then read, like a play?
○ interactive or one-way? (or interactive with a time lag?)
○ fiction? non-fiction? persuasive?
●Mode - The way it presented (written, spoken, blog, genre)
○ Domain-specific
■ Diagrams of program structure (package diagram, class diagram)
■ Diagrams showing how program behaves dynamically ( activity
diagram, sequence diagram)
■ Diagrams that support the software development process
(organization chart, Gantt chart)
● Field
○ The topic you’re talking or writing about
○ However clients are not experts in SE
Document Summary
Writing too much ( verbosity ) - be concise! Using words that you are not sure of. Fix - when modelling domain have a doc in which the terms being used in the project is de ned so that everyone in the team knows how to use. Agency : language that avoids active verbs (aka passive voice, bad because it sounds evasive) Eg. punches were thrown at the meeting. Vacuousness: using phrases that are complicated and actually mean nothing. Nerdview : failing to see how others see the world. Do executive summaries where necessary (long documents) Register - refers to the ways that language changes depending on the situation. Varies according to the relationship between the participants. Interactive or one-way? (or interactive with a time lag?) Mode - the way it presented (written, spoken, blog, genre) Diagrams of program structure (package diagram, class diagram) Diagrams showing how program behaves dynamically ( activity diagram, sequence diagram)
