Technical and User Documentation Technical Documentation Documentation must adhere to certain qualitystandards in order to avoid misunderstandings andfail to meet expectations. Add comments in database tables and columns toensure better understanding of structure Use annotations for database elements (i.e.screenshots) that require a more detailedexplanation2 Technical Documentation Framework– Operating System: Windows 7 & Later– DBMS: Ms … Continue reading “Technical Documentation | My Assignment Tutor”
Technical and User Documentation Technical Documentation Documentation must adhere to certain qualitystandards in order to avoid misunderstandings andfail to meet expectations. Add comments in database tables and columns toensure better understanding of structure Use annotations for database elements (i.e.screenshots) that require a more detailedexplanation2 Technical Documentation Framework– Operating System: Windows 7 & Later– DBMS: Ms SQL Server 2008 & Later– RAM required– CPU required– SPACE required Technical Documentation Applying a good naming convention Tables (column)» Use proper English and carry natural meanings. For exampledon’t give your table names prefixes like “tb” or “TBL_”» Avoid acronyms and abbreviations if at all possible» Avoid using plural names for tables, use singular forms.» Table name should map to the entity it is modelling.4 Technical Documentation Primary keys– Indicate primary keys with all tables to ensurea unique representation of each record– Get used to naming primary or foreign keyswith an ID identifier suffix (i.e. customerid)– DO NOT use the column name id to identify aprimary key. Foreign keys must be named consistently indifferent tables.5 Technical Documentation Relationships– Documenting the table relationships with clear names.– concatenate the names of the two tables. Example“Student” and “Course” tables should be named“StudentCourse”. Constraints – not null, unique, PK, FK, check8 Data Dictionary Annotations11 Technical Documentation Ensuring that comments exist for all T-SQL codessuch as– Tables and Columns,– Queries12 USER MANUAL User manuals are written to provide instructions onhow use a system The system may be– computer software or hardware,– electronic devices such as televisions, Good user manuals provide the following– educate users about the product’s features– teaching users to effectively use the device13 USER MANUAL Explain how to insert data to the database– Include images with annotations were appropriate Explain how to update the database– Include images with annotations were appropriate Show how to display information from the database– Use SELECT statements FAQs Video Tutorial Embedded assistance (tool tips) Support Portals14 ExerciseCreate the following documentations for theStudent_Course database you have created– technical documentation– User documentation– Search for SQL Server 2017 hardwarerequirements References http://www.doc-department.com/what-are-userdocumentation-and-technical-documentation/ https://www.locusassignments.com/solution/unit-17-database-design-concept-assignment
