Docs › TekReady

Section — Notes

Last updated 2026-07-14

Section — Notes

What this section captures

The Notes tab is a free-text space attached to the engagement. It exists for the narrative context that doesn’t fit anywhere else — assumptions, deferred decisions, “why we did it this way”, callouts to the customer reading the HLD, and internal nudges from Tekwurx consultants that should never reach the customer.

It is the last tab in the configuration subnav, after Incident Categories and Request Categories. It is the only section that does not require approval — edits land directly without a Draft / Final cycle.

Two boxes, two audiences

The page has two text areas, side-by-side:

HLD Notes	Goes into the generated HLD document under section “11. Engagement Notes”. Use this for anything you want the customer to read — assumptions, scope caveats, deferred items, references to attached documents.
Internal Notes	Partner-only. Never appears in the HLD, never visible to engagement members who aren’t in the Partner approver group. Use this for consultant-to-consultant context: dodgy decisions, things to revisit, cross-engagement hand-off notes, parking-lot items.

Access control

HLD Notes are visible and editable by any user with access to the engagement.
Internal Notes are visible and editable only to users who have the Partner approver capability. For everyone else the textarea is hidden — the page simply shows the HLD Notes box on its own.

If a user without Partner-approver rights somehow reaches the internal endpoint directly (e.g. via a stale URL), the server returns 403 — the access check is enforced server-side, not just hidden in the UI.

How edits land

Each box has its own Save button — they post independently, so saving HLD Notes won’t accidentally clobber Internal Notes (or vice versa).
There is no Draft / Final approval flow for Notes — the section is not approval-required. The Approval, Sign-off & Audit Trail page explains how this differs from every other section.
Edits are timestamped in the audit log against the user who saved them. The timestamp shown on the page is the most recent save of either box.

HLD output

When the HLD is generated, the HLD Notes text appears as section 11. Engagement Notes, formatted with light paragraph wrapping. Plain text only — no markup is interpreted. If the HLD Notes box is empty, section 11 is omitted entirely.

The HLD is now generated with a download-time language picker (English / French / German / Spanish / Italian). The chosen language localises the document’s “11. Engagement Notes” heading and surrounding boilerplate; the note text you typed is reproduced exactly as entered — it is never translated. See Generating & Downloading the HLD for the full walkthrough.

Suggested uses

HLD Notes	“The customer’s Active Directory integration is scheduled for phase 2 — the AD section in this document reflects the target end state, not what is live at go-live.”
Internal Notes	“Customer’s IT lead Sarah is on leave until 15 March — route any priority decisions through Tom in the meantime. Email responses still need a sanity-check by Sarah before final.”