Template-moduulin rooli¶

Repostage Template -moduuli on valmis rakennussarja, joka asennetaan uuteen tai olemassa olevaan projektiin. Sen tehtävä on varmistaa, että projekti on yhteensopiva organisaation standardien kanssa ja että se tuottaa tarvittavaa dataa laadunvalvontaan.

Template-moduulin rooli¶

Template-moduuli ei ole vain kansion luonti, vaan se tuo projektiin kolme tasoa:

1. Rakenteellinen selkeys¶

• Valmis docs-rakenne: Hakemistot arkkitehtuurille, ADR-päätöksille ja prosessiohjeille.

• Valmis mkdocs.yml: Konfiguraatio, joka on esiasennettu keskustelemaan Repostage-portaalin kanssa (teemat, plugin-asetukset, metadata).

2. Automaation integraatio (CI/CD Snippets)¶

• Moduuli tuo mukanaan valmiit putken osat (esim. GitLab CI include), jotka:

  • Validoivat dokumentaation (linting).

  • Ajavat koodianalyysit.

  • Generoivat raportit Repostagen ymmärtämään muotoon.

3. Ohjaavat sisällöt (Boilerplate)¶

• ADR-pohjat: Valmiit kysymykset, jotka pakottavat pohtimaan vaihtoehtoja ja vaikutuksia.

• README-pohja: Standardoitu tapa kertoa projektin tarkoitus ja status.

Koodipoikkeamien (Code Drift) tunnistaminen¶

Template-moduuli mahdollistaa koodipoikkeamien havaitsemisen tuomalla projektin osaksi automaattista vertailua.

1. Standardin määrittely: Templatessa määritellään organisaation "kultainen sääntö" (esim. testikattavuus > 80 % tai tietty kansiorakenne).

2. Analyysi: CI/CD-putki vertaa projektin todellista tilaa templaten määrittelemiin sääntöihin.

3. Raportointi Repostagessa: Jos projekti poikkeaa standardista, Repostage näyttää tämän "Architecture/Code Drift" -raporttina.

   • Esimerkki: "Projekti käyttää vanhentunutta kirjastoversiota, joka on ristiriidassa keskitetyn tietoturvaohjeen kanssa."

Työmenetelmien ja prosessien tehostaminen¶

Template-moduuli muuttaa dokumentoinnin osaksi tehostettua työnkulkua:

Vähemmän kitkaa (Low Friction)¶

Kehittäjän ei tarvitse keksiä pyörää uudelleen. Kun repo-template luo kaiken valmiiksi, kynnys dokumentoida ADR-päätös tai päivittää arkkitehtuurikuva on matalampi.

Jatkuva palaute (Feedback Loop)¶

Koska template sisältää laatuportit, kehittäjä saa heti tiedon, jos dokumentaatio tai koodin rakenne ei vastaa organisaation standardia. Repostage toimii tässä "tulostauluna", joka palkitsee hyvästä laadusta.

Itseohjautuvuus¶

Template-moduuli voi sisältää tekstiviittauksia Repostagen keskitettyyn Best Practices -osioon. Kun kehittäjä avaa templaten luoman tiedoston, siinä on ohjeet: "Katso Standards-osiosta, miten meillä on tapana kuvata API-rajapinnat".

Yhteenveto: Templaten hyödyt¶

Template-moduuli on siis Repostagen "tuntosarvi" projekteissa: se varmistaa, että jokainen repo puhuu samaa kieltä ja noudattaa samoja sääntöjä kuin muu organisaatio.

Dokumentin tila: Kehitys — Pvm: 13.01.2026