Architecture Decision Record

Active theme: Light

← dokumentit

Tiedostojen nimeämiskäytännöt

Jos luot ADR-tietueesi tavallisina tekstitiedostoina, saatat haluta keksiä oman ADR-tiedostojen nimeämiskäytäntösi.

Suosimme nimeämiskäytäntöä, jolla on tietty muoto.

Esimerkkejä:

  • choose-database.md

  • format-timestamps.md

  • manage-passwords.md

  • handle-exceptions.md

Meidän nimeämiskäytäntömme:

  • Nimi sisältää preesensissä olevan käskymuotoisen verbilausekkeen. Tämä parantaa luettavuutta ja vastaa commit-viestiemme muotoa.

  • Nimessä käytetään pieniä kirjaimia ja tavuviivoja (kuten tässä tietovarastossa). Tämä on tasapaino luettavuuden ja järjestelmän käytettävyyden välillä.

  • Tiedostopääte on markdown. Tämä voi olla hyödyllistä helpon muotoilun vuoksi.