Skip to main content

Implementation.md

In support of the principle of keeping documentation close to code, we recommend projects include an Implementation.md file.

The goal of this is to ease onboarding for new developers and a reminder for all other developers of the notable features and/or customisations.

Recommended content​

Here are some examples

Magento​

  • What are the major customisation areas?
  • Is it Hÿva?
  • What's technology stack is involved?

BigCommerce Themes​

  • What custom functionality does this theme have?
  • Is the theme deployed to multiple stores?

Headless​

  • What is the techonology stack?
  • Are there any project constraints that affected the implementation?

APIs & Integrations Layers​

  • The architecture and workflows that achieve functionality.