Integrations

Write the design doc before the work, and add to it as you go

A Notion design doc works as contemporaneous evidence when it states the problem and hypothesis before the work starts, records results under dated headings as they arrive, and keeps the original expectation intact. Its created and edited times show when the page was made and last changed, not when each passage was written, so keep its history.

Reviewed by George WalchFacts last verified

What Rand reads

  • The text of each shared design doc, so the hypothesis and results need to be written as text.
  • The day the page was created and last edited, and who last edited it.
  • Ticket keys and pull request links in the page title.

What it becomes in your claim

  • A dated record in the financial year the page was created, proposed for placement on the activity it documents.
  • Two work days for the page's last editor, the day it was created and the day it was last edited.

What Rand never does

  • Rand never writes to, edits or deletes your Notion pages.
  • No Notion page is claimed without a person reviewing it.

What makes a document contemporaneous

business.gov.au says records should be created at the time the activity is conducted, kept for five years after claiming the expenditure, and show the steps, trials, dates and people involved. It lists experimental plans, project plans and meeting records among the records that support core R&D. AusIndustry's software sector guide adds design notes and architecture decision records. The ATO's ruling TR 2018/2 says electronic records, including those stored in the cloud, carry the same record keeping requirements as paper records and must be in a form the ATO can access and understand.

So the format is fine. What matters is timing and content: the expectation written down before the work, and the outcome recorded after it, without one overwriting the other.

A page template that keeps the sequence

  1. Status and dates. Started, owner, linked tickets and pull requests.
  2. Problem. The technical hurdle, with the measurement that shows it.
  3. What we checked first. Published methods, vendor documentation or prior attempts, and why they did not answer the question.
  4. Hypothesis. What you expect, and the result that would prove it wrong.
  5. Options considered. Each option and why it was chosen or rejected.
  6. Log. A dated heading for each experiment or week, with what was run and what was observed.
  7. Conclusion. Whether the hypothesis held, what was learned and what comes next.

Sections 2 to 5 are written before the work and afterwards changed only by dated additions. Sections 6 and 7 grow as the work happens.

Good and weak design docs (illustrative)

These pages are illustrative examples.

WeakStronger
"Sync engine design", last edited in July, describing only the final design"Offline sync conflict resolution", created in February with the hypothesis, plus dated log entries to June
Hypothesis section rewritten to match the resultOriginal hypothesis kept; a dated entry records that it was disproved
Results pasted as a chart imageResults as text with the chart below it
One page covering three years of workOne page per experiment cycle, linked from a project index
Tidied by a manager last, author unknownAuthors named at the top; reviewers comment rather than rewrite
Deleted when the project shippedMoved to an R&D records space and kept

Habits that protect the record

  • Date everything inside the page. Notion records created and edited times, but dated headings show the order within the page.
  • Add to the hypothesis rather than rewriting it. If it changes, add a dated entry saying why. A silently rewritten hypothesis reads as hindsight.
  • Keep the history. Notion's page history shows what changed and when, but how far back it goes depends on your plan. Export the page when the hypothesis is set and when the work concludes if you need a longer record.
  • Prefer a new page over a renamed old one. A new cycle with a new hypothesis is a new page, linked to the last.
  • Keep text as text. Diagrams help, but write the numbers and conclusion in the page body.

What Rand does with design docs

If you connect Notion and share these pages, Rand reads their text, including nested blocks and captions, but not the contents of images, PDFs or embeds. It assigns each page to the financial year it was created and attributes it to its last editor. A page started in an earlier year is not read for the current one, which is one more reason to start a fresh page for a new cycle. Pages in the trash, which Notion reports to Rand as archived, are skipped.

Each page becomes a record that Rand's AI proposes to place on a core or supporting activity, for your team to confirm. The Jira worklogs guide covers the time side of the same work, and the contemporaneous evidence glossary entry and R&D Tax Incentive resources cover the rest.

Frequently asked questions

Is a page written after the experiment still useful?
It is better than nothing as a summary, but it is weaker than a record made at the time. Say so on the page and link the dated tickets, pull requests and results it summarises, rather than presenting it as written earlier.
Can we edit a design doc after the work starts?
Yes, but add rather than replace. Keep the original problem and hypothesis section unchanged and record changes and results below it under dated headings.
How long should we keep these pages?
business.gov.au says to keep R&D records for five years after claiming the expenditure. Keep the pages in a space that will outlive the project, and export them if the workspace or plan might change. Moving a page into an archive space is fine; deleting it or losing access to the workspace is what loses the record.

Sources

  1. business.gov.au: Record keeping for the R&D Tax Incentive
  2. AusIndustry: Software development sector guide (design notes and architecture decision records)
  3. ATO: TR 2018/2 Income tax, record keeping and access, electronic records

The R&D Tax Incentive is a self-assessment program. This page is general information, not tax, legal or financial advice; eligibility depends on your circumstances and you should seek independent advice for them.