FIT2043 Lecture Notes - Lecture 5: Software Architecture, Risk Management
13 Jun 2018
School
Department
Course
Professor
L5 - Document Standards
Different Kinds of Standards
● Written style and grammar
● Layout and presentation
● Document structure
● What documentation must exist
Why Have Standards?
● Help maintain consistency in documentation within project
○ Principle of least surprise
● Help communicate a certain level professionalism
● Help communicate efficiently
Who Sets Standards?
● Standard bodies (IEEE-SA, ISO)
● Publishers
● Universities
● Research Organizations
● Individual companies
(Written) Style Guides
● Cover aspects of writing styles sometimes cover margins, headings and
subheadings
● Examples: Chicago Manual of Style, New Oxford Style Manual
● Some places say you have to adhere to style, some don’t. It just depends.
● How does it help?
○ Consistency in punctuation
○ Consistency in addressing (Mr, mister)
○ How to emphasize something
○ Consistency in usage of certain words or phrases
■ E.g These this data is or this data are
■ E.g Inquire or Enquire
Document Summary
Help maintain consistency in documentation within project. Cover aspects of writing styles sometimes cover margins, headings and subheadings. Examples: chicago manual of style , new oxford style manual. Some places say you have to adhere to style, some don"t. Consistency in usage of certain words or phrases. E. g these this data is or this data are. A document that contains the information a team needs to manage themselves: internal. What needs to be delivered and when. Other systems it needs to work with. Who to talk to in other organisations (client, vendors), who is responsible for talking to them. How will we allocate tasks to people. How will we keep track of the amount of time they are spending. What will we qa, how, when and who is charge of it. If problems arise, what will we do about them. The team: to understand how the team works and anybody who needs to look up the team"s policy.
