Skip to content

Streamline the Documentation of Marketing Technology

Date: 2025-02-26

Status: 🟠 Proposed

Context

A strong team needs strong documentation. Documentation is not only a tool for democratizing knowledge, but also for improving the efficiency of processes. Everyone loves good documentation that allows you to work on a task almost immediately.

Decision

The new way of documenting for team MarTech will look like the following.

  • We use the Statista-wide Documentation Hub deployed on GitHub Pages (Documentation Hub) to improve overall accessibility.
    • automatically captures the /docs folder within repositories
    • enables documentation close to the code
  • What about Miro Boards?
    • Add them with an appropriate description as a .md file in the respective repository. Include some graphics from the Miro Board there.
  • What about things that can't be linked to just one repository?
    • This is where this repository comes into play. It serves as a starting point for any new Marketing Technology documentation.
  • We define rule.
    1. Anything that can be documented in one single repo, should be documented there (high cohesion).
    2. Anything that is an overreaching topic (e. g. documentation would be needed in two or more repos) should be documented here (loose coupling).

Consequences

  • We might want to move some of the documentation from confluence to GitHub.
  • We don't create shared documentation in confluence anymore.
  • Higher accessibility.
  • Higher efficiency of processes.
  • Better user/developer experience for our documentation.
Last updated: March 17, 2025 at 08:49
By: Phil Pieper