Click here to access the Github repository.

This page is part of the Engineering Academy Documentation Assignment
Engineering Academy Session One took place on 29 March 2020.
Engineering Academy Session Two took place on 30 March 2020.

Click the link above for more information on the assignment.
In case the link becomes broken in the future, A short description is provided below.

Background

The following was covered in the 29 March morning session:

• Why we need to document
• If you don't document your work, it is as if it didn't happen
• Introduction to HTML and CSS
• Perhaps a basic understanding will get you through. That could be done in 12 minutes.
• Webpage hosting on GitHub
• Why not? It's FREE!
• Version control using Git
• This could save you from losing your precious work
• Markdown as an alternative to HTML
• It's easier to write, but less flexible especially in terms of styling.
• It has the full power of HTML but not so much of CSS.

Requirements

• Show an understanding of the importance and need for good documentation.
• Create a website with at least 3 pages
• Home Page
• Introduction of what your site intends to host
• A brief outline of the site's contents
• e.g. projects, experiences, skills-learnt, mistakes made, new technical products
• Project Page(s)
• Documenting experience with HTML, CSS, GitHub, Git and/or Markdown.
• How you setup your site etc.
• e.g. document how Github Desktop is used for archival, with relations to Git commands.
• About
• Tell the world about yourself.
• Leave out confidential data e.g Your birthday, NRIC or bank details.
• Make it interesting so that a reader would want to follow your exploits!
• The following WWW characteristics:
• A uniform look across all pages
• Navigation from the Home Page to the other pages
• A common header, footer and navigation
• Images and side-by-side text
• Links and references
• A way to contact you through social media e.g. email, etc
• Place all your images (photos, drawings, screenshots) in a folder names "images" to separate it from the rest of your web-pages.
• Host your website on Github using the project-name engacad.
• Use Git to manage your web-site