Managing Project Log Book on OneNote

A background

Having agile portfolio management on Team Foundation Server is fun. But sometime, it burdens several roles to join the party. For example, it is not easy for executives to check the project log book since its need Visual Studio Installed. If they are using a web, they should join a services to get the information. A simple way is to deliver the log book through a Microsoft Office platform. On this article, we will show you how to create project log book on OneNote

Before you Go

If you want to do this practice be sure you have

  1. Visual Studio Membership on it's only needed for the developers' team.
  2. You have Office 365 subscription OR at least Microsoft Account to get OneDrive storage / OneDrive For Business storage
  3. Understanding how Scrum or eXtreme Programming is done.
  4. You have OneNote installed for you and for your team


Ok after we fulfil the perquisites, let's do these steps

  • Create a shared folder on your OneDrive / OneDrive for Business. For example, I create a folder namely "SharePointAppVoter", if I want to build the project for SharePoint.
  • On that shared folder creates a OneNote file and give the name "SharePointAppVoter-Log-Book". In order to do that open your OneNote, choose New Notebook, and then browser your OneDrive for the folder that you already created.

  • It is time to create the OneNote. We assume you use agile method, here is the structure that we are proposed.
  1. Readme. A guidance to use this OneNote Log Book. It contains what and how aspect to implement MSF (Microsoft Solution Framework) Agile. You can do similar if you want to implement CMMI or SCRUM based Log book with just replacing the terms. For example, Iteration becomes sprint on the Scrum.
  2. Exploration. This is the first phase of MSF Agile. The purpose of this sections is understanding the requirements of the project. It should but not limited with several pages below:
    1. Agile Team. It contains list of the team member, its role, its communication, and they working preferences.
    2. Features. It contains features that is requested by the product owner. Features are the capability of a proposed system. This page can be filled by exporting the features sheet from the TFS.
    3. Users. List of actor that will be used the system. It can be further described through Persona.
    4. User Stories. List of requirements that is presented through user story. A feature contains one to many user story. This page can be filled by exporting user story from the TFS. Each user story will have user story description
    5. Architectural Spike. It contains basic idea how the solution will be proposed. The architectural spike will have but not limited to
      1. Spike Solution or Big picture of the system (alias Deployment Diagram). It shows the platform and the relation between the systems.
      2. System Metaphors (alias Wireframe). It shows the basic interaction between the users and the proposed solution.
    6. References. List of references that obtained from the internet and its useful for this project.
  3. Planning: a list of planning based on the requirement of the project.
    1. Release Plan. A main page that show versioning plan for a proposed solution. Each release plan page will have one to many iterations. This page can be exported from the TFS iteration plan.
  4. Iteration: a phase of construction (code, development, testing, and bug fixing). It contains several pages such as
    1. Iteration Page. The 'definition of done' on the iteration. The iteration page has several subpages which are
      1. Standup Meeting page. Scheduled meeting notes that agreed by the whole team.
      2. Acceptance test page. The list of test that is done on the iteration. This activity can be done through TFS.
      3. Bugs. The list of the bugs that happens on the iteration. The bugs can be exported from TFS
  5. Production: the page that related with the development-operations of the product (Dev-Ops). It includes
    1. Development Configuration Page. A configuration of development or staging server.
    2. Deployment Configuration Page. A configuration of deployment or production server.
    3. Production Artefact. It includes but not limited with
      1. User Manual and Guidance
      2. Installation and Configuration Procedures
  • After creating a OneNote. You can share the OneNote to the others team through email by choosing share the notebook

Add comment

  Country flag

  • Comment
  • Preview

Topics Highlights

About @ridife

This blog will be dedicated to integrate a knowledge between academic and industry need in the Software Engineering, DevOps, Cloud Computing and Microsoft 365 platform. Enjoy this blog and let's get in touch in any social media.


Month List