Internal notes
🟦 Information on the use of internal notes in project components
This text provides background information. What types of text are there?
Purpose of internal notes in project components
Internal notes are an integral part of the work packages within project components. Their purpose is to provide employees who will later work on the implementation with additional information and specific instructions for processing the respective work package.
Project components are used to pre-structure recurring projects. They facilitate requirements management - i.e. the coordination of customer requirements with the services offered - and ensure a smooth transition from planning to implementation. A work package within a project component typically consists of three areas:
- A) Description: a general text describing what is to be done in this work package.
- B) Customer requirements: A form in which the customer's individual wishes and specifications are recorded.
- C) Internal notes: Instructions and notes for the employees who implement the work package.
The first two areas - the general description and the customer-specific requirements - are thus incorporated into the specifications . The requirements specification is mainly aimed at the customer and serves to define the project results in a binding manner.
Once the requirements specification has been approved, implementation begins. The work packages are converted into tickets. These tickets contain the specific work orders for the employees. This is where the internal notes become relevant: They are not intended for the customer, but help employees to carry out the task efficiently and correctly. For example, technical details, implementation instructions or known problem areas can be documented here.
In a nutshell, internal notes are therefore instructions for your team. They serve to make the transition from planning document to practical implementation easier for employees and ensure that the work packages are implemented as intended.
How internal notes should be used
In principle, you can add internal notes to every element of a component. The addressee is your own team. The point is to provide your employees with implementation instructions for the work package and to describe exactly HOW they should solve the task.
Example: A work package in which the creation of wireframes is defined as part of a website projectDescription text: "The work package "Wireframes" comprises the creation of low-fidelity drafts for the visual representation of the page structure and user guidance. The aim is to define the basic elements and layouts of the website before starting the detailed design."This text is aimed at the customer and explains the work package in the specifications. Internal note:"Start with a rough sketch of the most important pages (e.g. home page, contact page, product page). Use a tool such as Balsamiq, Figma, Adobe XD or Sketch to create digital wireframes. Make sure that all navigation elements and page links are included in the wireframes."This text is not displayed in the specifications, but only in the implementation ticket and is aimed directly at the responsible employees.