Skip to content

Latest commit

 

History

History
67 lines (47 loc) · 2.65 KB

R08.about.md

File metadata and controls

67 lines (47 loc) · 2.65 KB

CSC493: R08: The About Section1

Overview

You have two main tasks for this week:

  • Draft an about statement and embed it in the README.md file
  • Complete a new software component, which can again be small.

You should always be improving your documents as more details become apparent.

DO NOT TAKE THIS AN OPPORTUNITY TO SLACK OFF.

About section

Add biographical information to your README.md file under the author's name. In many software releases, you will find an “About the Team” section. This section includes brief biographical information is offered about each team member. This biographical information is almost always written in the third person, though it can still be very personal and can give insight into the person’s personality and character.

See examples at:

For this week, you can include an avatar of yourself and instead of calling it "About the Tean", you can call yourself something like "Lead Developer" because you are working by yourself.

More Software development

As mentioned before, all agile design methodologies recommend breaking systems down into small units that you build incrementally but consistently.

Fully implement another small portion(s) of your project and ensure that you follow good practices, such as meaningful function and variable names and extensive informative comments.

Be sure to identify which component you have fully implemented in your weekly report.

Documentation

As a weekly practice, you should be improving the various documents you created already, such as requirements.md and design.md.

README.md

You should update the README.md file your "About" section and with any updates as necessary.

  • Project name
  • Project Concept (linked to concept.md)
  • Vision
    The paragraph of your vision is here.
  • Scope
    The paragraph of your scope is here.
  • Prerequisites
  • Requirements (linked to requirements.md)
  • Design (linked to design.md)
  • Built With
  • Author name
    • About the Lead Developer PUT YOUR BIOGRAPHICAL INFORMATION HERE
  • Acknowledgments

To Submit

In addition to creating the design.md file, update README.md as necessary.

Make sure your repo is current by pushing any changes.

1. Adapted from https://github.com/pearcej/pearcej.github.io/edit/master/csc493/r04-design.md