Code Monkey home page Code Monkey logo

colin-patty_user_guide's Introduction

Overview of myBCIT Email Instructions

Hello! Congrats on getting into BCIT ๐Ÿ‘ With a new school unfortunately comes with a new email system. This guide will walk you through some neat tips and tricks into how to use the myBCIT email system to make your life at school a lot easier.

The topics we cover are:

  • Email forwarding
  • Email signatures
  • Replying to instructors

Tools Used to Create Guide

Having struggle ourselves through using the email system, much of what we referenced was from our own personal experience. Classmate inputs were also taken to help provide the easiest streamlined guide.

MkDocs

MkDocs provided a great way to provide an esthetic website build. It had several built in components that were easy to customize and provided a lot of variety in terms of themes and overall appearance.

Markdown Language

For both team members, this was the first time we used Markdown language for a larger scale project. Having gone through Markdown walkthroughs, it was beneficial to be able to apply our knowledge and gain experience with using the language.

VSCode

Using VSCode we were able to work collaboratively on the same document by linking to a shared GitHub repository.

Writing Style and Organization

When writing this guide, we wanted to ensure that it would be welcoming and readable for the reader. Therefore we used language that was clear and concise.

Alert Blocks

To help ensure readability, we utilized the MkDocs' alert blocks to notify the reader about different types of information.

Denotes actions that users must avoid taking to prevent issues. image

Indicates next action to take in case of failure. image

Denotes information that must be read to ensure full understanding of unavoidable issues. image

Denotes additional information or helpful tips. image

Indicates next action to take in case of success and gives an example image of successful action. image

Layout

In addition to the alert blocks, we also used a built-in MkDocs navigation layout in order to show subsections of each page. This allows the reader to easily backtrack or move to a different page when needed.

Conclusion

This documentation was made to help incoming BCIT students use their MyBCIT email account to the fullest while reducing the confusion that comes with some tasks. It was enjoyable for us to write as many of these tasks were things we had to figure out ourselves in our first term.
Writing this documentation was also a fantastic opportunity for us to learn how to use MkDocs for documentation and write clear instructions for an intended audience.
Thank you for taking the time to read this! We hope this documentation helps you figure out your MyBCIT email and that you pass it on to anyone else who may find it useful.
This documentation was created using Material for MkDocs

colin-patty_user_guide's People

Contributors

cdoig4 avatar hsu-patty avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.