Landing : Athabascau University

Group members: use the discussion to seek help, give help, or simply to share ideas with others that do not comfortably fit in your learning diary.

QUICK COURSE LINKS:  Add blog post - Read latest group postsFAQs: Course process : Site design : HTML : CSS : JavaScript : JQuery : AJAX : Misc

Documentation?

  • Public

Documentation?

Started by Kimberly Lindsay March 2, 2022 - 12:14am Replies (2)

Does anyone know if we are just using comments in our source code for the documentation, or are we meant to create a separate documentation file? This is in regards to HTML and CSS for units 2 & 3. 

I'm also sort of confused about our CSS submission on the SCIS webspace - It says if we make minor changes to our HTML we need to document it in our original files - but it only asks to upload the CSS files, not new HTML iterations - however, they are slightly changed, so should I just upload the entire zip file with the new HTML pages, or should I go into my unit 2 files and change them... is that allowed?

 

 

 

Replies

  • Jon Dron March 2, 2022 - 9:19am

    For the first question, comments in source code are usually enough for HTML and CSS but, if you have lengthy things to say about the work, do put them in your learning diary.

    For the second question, don't ever destroy previous work by overwriting it! We need to be able to see how it has developed over time, and you may need to go back to it if things go wrong. It is best to upload everything that has changed since you last uploaded it. To keep things simple, I recommend uploading the whole site.

    Hope this helps,

    Jon

  • Kimberly Lindsay March 3, 2022 - 12:40pm

    Thanks Jon!