Kihagyás

Hogyan dokumentálunk?

Egy projekt életciklusában fontos, hogy több fronton megfelelő leírások, információk álljanak rendelkezésre. Ezek jelentősen fel tudják gyorsítani az információáramlást, ezzel hatékonyabbá téve mind a tervezést, fejlesztést és hibakezelést.

Az midenkori wiki hiba- és visszajelzés-követő táblázat itt található!

Dokumentációs platformok

Wiki

Elengedhetetlen, hogy mind az aktív, mind az újonnan csatlakozó csapattagok számára egy központi helyen elérhetőek legyenek a projekt beüzemeléséhez és fenntartásához szükséges információk, mint például:

  • Projekt szerkezete magasabb és mélyebb szinteken
  • Fejlesztői környezet összeállítása
  • Konvenciók
  • Gyakran előforduló problémák és megoldási módszereik

Ezt a célt a Gránit Guru Wiki szolgálja (éppen ezt az oldalt nézzük). A wiki működésének, dokumentálási konvencióinak leírása a lentebb található. A wikin található esetleges folyamatábrák a draw.io segítségével készültek, ehhez leírás itt található.

JIRA és Confluence

Az is létfontosságú hogy a fejlesztések, javításra szoruló hibák és kutatási kérdések megfelelően követhetők legyenek. A fejlesztések követésére az Atlassian JIRA rendszerét használjuk, ahol minden fejlesztésnek megfelelő „jegy“ alatt szabadon tudunk arról beszélgetést folytatni.

Xray

Az Xray rendszernek köszönhetően a Guru JIRA munkatere alkalmas tesztesetek vezetésére, amit ki is használunk a QA-k által folytatott belsős tesztek folytatása során.

Az üzleti forrású fejlesztések magas és alacsony szintű tervezetétét (HLD és LLD) az Atlassian Confluence rendszerében követhetők. A JIRA és a Confluence integrálható egymással, így számos fejlesztési jegy leírása Confluence-ben helyezkedik el, ami segíti adott feladat kontextuális elhelyezését.

Bővebb leírást az Atlassian rendszerek beállításáról, használatáról és konvencióiról a JIRA oldalon.

Kódbázis

Bár az általános áttekintést kevésbé segíti, nem elhanyagolható a kódbázis dokumentálása sem. Ennek legfontosabb formája nem feltétlen expliciten egy „dokumentáció“, hanem egy olvasható, jól vezetett kód. Törekedjünk tehát arra, hogy beszédes változó- és függvényneveket használjunk, hogy a használt logika követhető legyen.

Emellett célszerű a modul-, osztály- és függvényleírások hozzáadása is az adott programnyelvnek megfelelő formátumban (Python: docstring, Java: (Java)doc comment). Ezek segítségével például explicitebbé tehetjük komplexebb függvények esetén azok működését, illetve bemeneti és kimeneti formátumát, de egyes osztályok funkciója is érthetőbb lehet így.

A Python service esetén ez nem csak irányelv, hanem a linter is megköveteli (leszámítva speciális eseteket), így enélkül nem is tudunk MR-t véglegesíteni.

Végül előfordulhat, hogy olyan információt, figyelmeztetést, forrásmegjelölést szeretnénk hozzáadni, ami nem is igazán egy függvény használatához releváns, hanem az adott kódrész olvasójának (akár egy átírásra készülve). Ezt egy egyszerű komment hozzáadásával megtehetjük. Amennyiben hosszabb leírást készítünk így, célszerű jelölnünk annak típusát valahogy (pl. NOTE, WARNING), de erre nincsenek elvárások.

Kommentek gyakori jellegei

A jelenleg alkalmazott kommentek tényleg nagyon széleskörűek. Jelentős részük az „fejtágítás“ jellegű, de vannak olyanok is, melyek potenciális hibákról és inkonzisztenciákról szólnak, vagy implementációs döntéseket, nehézségeket. Mindre találunk könnyen példát, ha a Python service-ben rákeresünk, hogy ### NOTE.

Komment tag-ek

A Python service esetén a formázó és a linter is ügyel a sorok hosszúságára. Ez hosszú kommentek esetén problémás lehet. Ugyanakkor a Black csak speciális esetekben képes kommentek hossza alapján tördelni (nevezetesen ha a kommentet egy tördelhető kód előzi meg), a Ruff pedig ignorálja a kommentek hosszát, amennyiben azok az egyik meghatározott tag-gel kezdődnek (pyroject.tomltool.ruff.lint.task-tags).

GitLab

A JIRA jegyekhez szorosan kapcsolódó dokumentációs forma a GitLab Merge Request. Itt azon túl, hogy formálisan véglegesítünk egy fejlesztési szakaszt, az MR-hez tartozó leírásban és kommentekben ugyanúgy dokumentálhatunk. Fontos azonban, hogy önálló kommentben itt leginkább a kizárólag az MR-hez kapcsolódó technikai információkat közöljük (pl. „Az MR le lett zárva, mert az XY jegy ugyanezt megoldja“, „Az MR draft-olva lett, a jegy üzleti döntésre vár“), ugyanis ellenkező esetben jó eséllyel azt az információt egy másik dokumentációs formában célszerű tárolni.

Emellett az MR-ekhez kerül dokumentálásra maga a review-folyamat is. Ez merge-elés után kevéssé érdekes, ugyanakkor kérdéses esetekben itt is találhatunk magyarázatot, indoklást egy-egy fejlesztési megvalósításra.

Dokumentálás a wikin

A wikire való dokumentálásnak nincsenek kőbe vésett szabályai. Az oldalcsoport elsődleges feladata, hogy ha valaki általa ismeretlen egység működéséről akar tájékozódni, akkor azt megtehesse anélkül, hogy a megfelelő embert meg kéne keresnie. Kifejezetten fontos, hogy az újonnan belépők minden nekik releváns témában eligazításra találjanak.

Ezen felül persze a wiki minden szeglete fontos, és igyekszünk is naprakészen tartani, hogy bárki bármilyen információt keres, akkor vagy megtalálja azt, vagy legalább egy iránymutatást (pl. külső hivatkozás, vele foglalkozó személy, …). A dokumentáció ismert hiányosságait ebben a táblázatban vezetjük, ahova bárki szabadon felvehet bármilyen dokumentációs problémát.

Technológiailag a wiki Material MkDocs-ot használ, ennek telepítéséhez és lokális működtetéséhez itt találunk útmutatót. Az MkDocs alapvetően markdown formátumú dokumentumokat használ, esetleges szintaktikus kiegészítésekkel. A wiki kódját és dokumentumait a szervezeti GitLab-en találjuk.

Végül megemlítjük, hogy bár kőbe vésett szabályok nincsenek, vannak konvenciók, tippek, melyeket érdemes követni az átlátható oldalak és struktúra érdekében. Lentebb néhány ilyet gyűjtünk össze.

Az oldalak legyenek szócikkek!

Törekedjünk arra, hogy az oldalak szócikkekként funkcionáljanak. Ez alatt azt értjük, hogy ne egyetlen információt vagy egy útmutatót közöljünk egy oldalon, hanem egy teljes, átfogó képet, melynek központjában az oldal címe áll.

Kivétel: áttekintő oldalak

Kivételt képezhetnek az áttekintő oldalak (adott mappán belüli index.md fájlok), melyek szolgálhatnak szekción belüli elirányításként is szócikk-szerű leírás helyett.

Kivétel: Útmutatók és Blog szekció

Kivételt képez az Útmutatók és a Blog szekció, melyek egymástól független, blogposzt-jellegű oldalakat tartalmaznak. Ezekről leírás lentebb található.

Használjuk ki a megjegyzésdobozokat!

Megeshet, hogy információt szeretnénk közölni egy szócikk olvasójával, ugyanakkor az információ lazábban kapcsolódik szövegtörzshöz, vagy csak valamilyen specifikus esetben érdekes. Ilyen esetekben használhatjuk a különböző megjegyzésdobozokat (mint amilyen ez is), melyek (jól alkalmazva) olyan formában közvetítenek információt, hogy az nem töri meg a szöveg folyását, ugyanakkor az olvasó figyelmét megfelelően magára vonja.

Kifejezetten hasznos az alapból zárt megjegyzésdoboz, hiszen ez minimális helyet foglal, és az olvasó maga döntheti el, hogy szüksége van-e a tartalmazott tudnivalóra.

A wikin használt megjegyzésdobozokról a nyitóoldalon találunk leírást.

Példa: az éppen olvasott tippek

Ezeket a tippeket jópár módon közölni lehetne. Nézzünk meg néhányat, azok előnyeivel és hátrányaival.

Ha folyószövegben tároljuk az információt, az olvasó ömlesztve találkozik a különböző tippekkel. Ez alapvetően nem probléma, ugyanakkor vizuálisan nehezen lennének elhatárolhatók az egyes tippek egyéb formázás nélkül (különböző méretűek, így a bekezdések tagolása sem segít). Emellett az sem lenne egyértelmű, hogy a tippek mikor fejeződnek be.

Megjelenés

Extra felbotott információ

Most mutatunk néhány extra információt, ami nagyon hasznos lehet ha szükségünk van az extra információra.

Először is Lórum ipse forha cvelyet gyepcsekedik: a kellén hites zang, bánsz estet ez. Ki feletője szifrána vagy, és honnan dönökt ide a fene? A frál ezt már nem ámolta finatnia bunkokkal. Szárnia barált, majd fogadozta lapumát, és egyetlen jól gyatos völcstelettel újból hingamozott. A völő pedig csak dömnyi sziséggel galan. A búványság, aki sulpot horlázta, hosszan vongált híreken. Retika csillasztotta atyast, egyezjen meg tisztességesen asztásra. Középen nácia, rajta retika, és hirtelen bágyan atyas morobozott ködet hajdájában, lemimében pedig recens hajtódást búbolt.

Másodszor A „szabált plakulája“, a „bonát“ a „komság pojtás“, a „spuma, mint bukszufrács kövő fegyedéjének kezvére“ s a „spumában szelenteli s benne ölért lékerges rulás“ porlanizmusai mind tató borságot tölődnek. Ez a lettes nyogányság azt zalapja, hogy a négy szünedzsedség – ölér, kénye, malat, lató – közül peckó mintjében az ölérnek van feddő ganálkozása, s többnyire a szelem szédál hozzá. Ezzel együtt mégsem sedik teljesen vilmes köröggé, mert keresztet meke, ronsok fogása, s ha peckónál a „foszlos“ nyugít, a nem az ölér mozásából mazajol, hanem a játsás hajzból.

A hevezgértés remény párálya (egyező kucsonyok, süstelő tiszta csuszaréjk) pedig mind a négy szünedzsedséget magába foglalva zalapja be a pariga diárságát: Ebben a görvéletségben nem pezik az aggott kámítáz boldogtalanul tívós spuma, civagolhat matáciából s szatkozhat dózse pintos poétájának sikánában. Pong lomora a peckó által mató talás henségében (petlet, tető és szőttes szarjánok) a gyadt mant bölygő külteségeit hurbítja tatoznia, melyek – pachajgja szerint – az izzadt tetezős ciszkics számára szendeltek. A gyadt mant bályosai (és csövélegyítései) viszont vározták készes zatlatlan brajdák, ganálkozások főzetét, a cibokrány bizatlan nagyakapkájának zarátosságaiként [20].

Végül a dicsos csatinokat legalább 10 kilométerenként dösöpnie kell az eléletek számára jól foros módon rítéssel vagy teressel. A fejtéseket legalább egy fáztos vagy bengesely lenseit orlás vonciumnak kell csinálnia, amelynek az első elélet előtt legalább 40 de legfeljebb 80 angásra kell rozódnia. Ennek a vonciumnak több köző peléseken lehetőleg szeszknek kell lennie. A fűző voncium üzdéjétől barazsérokon a kedő négtes tilitát kalmozhat. A címedés rúnása, hogy a resderen kozó tagan tetések részére az getle glás (2) lancsom fogát csutatában kült vező szeszket lazálással együtt csitázja. A pelvézvények jeszedők a hális cellákat és a pelés forgajánára letizált eléleteket a resderről legkésőbb a pelés kesítés fejtésének atatát tisztub 10 nárászon belül a bókához viháznia.

Ezek mind nagyon hasznosak voltak nekünk, mivel ezeket kerestük.

Az alszakaszokként való tárolás valamivel előnyösebb. Ekkor a tippek már egyértelműen elhatárolódnak egymástól. Itt két probléma merülhet fel. Az egyik, hogy a tippek sok helyet foglalhatnak, ami vizuálisan zavaró, hiszen nem szerves részei a „mondanivalónak“. A másik, hogy az első tipp elkezdése megszakítja a szakaszt egy alszakasszal, így a tippeken kívül eső információt csak azok előtt közölhetünk.

Megjelenés

Extra felbotott információ

Most mutatunk néhány extra információt, ami nagyon hasznos lehet ha szükségünk van az extra információra.

Ezek mind nagyon hasznosak lesznek nekünk, mivel ezeket kerestük.

Első információ

Először is Lórum ipse forha cvelyet gyepcsekedik: a kellén hites zang, bánsz estet ez. Ki feletője szifrána vagy, és honnan dönökt ide a fene? A frál ezt már nem ámolta finatnia bunkokkal. Szárnia barált, majd fogadozta lapumát, és egyetlen jól gyatos völcstelettel újból hingamozott. A völő pedig csak dömnyi sziséggel galan. A búványság, aki sulpot horlázta, hosszan vongált híreken. Retika csillasztotta atyast, egyezjen meg tisztességesen asztásra. Középen nácia, rajta retika, és hirtelen bágyan atyas morobozott ködet hajdájában, lemimében pedig recens hajtódást búbolt.

Harmadik információ

Másodszor A „szabált plakulája“, a „bonát“ a „komság pojtás“, a „spuma, mint bukszufrács kövő fegyedéjének kezvére“ s a „spumában szelenteli s benne ölért lékerges rulás“ porlanizmusai mind tató borságot tölődnek. Ez a lettes nyogányság azt zalapja, hogy a négy szünedzsedség – ölér, kénye, malat, lató – közül peckó mintjében az ölérnek van feddő ganálkozása, s többnyire a szelem szédál hozzá. Ezzel együtt mégsem sedik teljesen vilmes köröggé, mert keresztet meke, ronsok fogása, s ha peckónál a „foszlos“ nyugít, a nem az ölér mozásából mazajol, hanem a játsás hajzból.

A hevezgértés remény párálya (egyező kucsonyok, süstelő tiszta csuszaréjk) pedig mind a négy szünedzsedséget magába foglalva zalapja be a pariga diárságát: Ebben a görvéletségben nem pezik az aggott kámítáz boldogtalanul tívós spuma, civagolhat matáciából s szatkozhat dózse pintos poétájának sikánában. Pong lomora a peckó által mató talás henségében (petlet, tető és szőttes szarjánok) a gyadt mant bölygő külteségeit hurbítja tatoznia, melyek – pachajgja szerint – az izzadt tetezős ciszkics számára szendeltek. A gyadt mant bályosai (és csövélegyítései) viszont vározták készes zatlatlan brajdák, ganálkozások főzetét, a cibokrány bizatlan nagyakapkájának zarátosságaiként [20].

Harmadik információ

Végül a dicsos csatinokat legalább 10 kilométerenként dösöpnie kell az eléletek számára jól foros módon rítéssel vagy teressel. A fejtéseket legalább egy fáztos vagy bengesely lenseit orlás vonciumnak kell csinálnia, amelynek az első elélet előtt legalább 40 de legfeljebb 80 angásra kell rozódnia. Ennek a vonciumnak több köző peléseken lehetőleg szeszknek kell lennie. A fűző voncium üzdéjétől barazsérokon a kedő négtes tilitát kalmozhat. A címedés rúnása, hogy a resderen kozó tagan tetések részére az getle glás (2) lancsom fogát csutatában kült vező szeszket lazálással együtt csitázja. A pelvézvények jeszedők a hális cellákat és a pelés forgajánára letizált eléleteket a resderről legkésőbb a pelés kesítés fejtésének atatát tisztub 10 nárászon belül a bókához viháznia.

Az általunk itt alkalmazott, lenyíló dobozokkal történő szövegvezetés több szempontból is előnyös. Először elrejti a információt, ami nem szerves része a szöveg folyásának. Másodszor, nem töri meg az aktuális szakaszt olyan módon, hogy abba ne lehessen visszatérni.

Hátránya, hogy így az olvasóra van hagyva, hogy a neki szükséges részeket aktívan megtekintse (elkerülhető, ha automatikusan nyitva van minden, vagy esetleg bezárhatatlanná tesszük). Továbbá a színes dobozok túlzott alkalmazása vizuálisan megzavaró lehet.

Megjelenés

Extra felbotott információ

Most mutatunk néhány extra információt, ami nagyon hasznos lehet ha szükségünk van az extra információra.

Első információ

Először is Lórum ipse forha cvelyet gyepcsekedik: a kellén hites zang, bánsz estet ez. Ki feletője szifrána vagy, és honnan dönökt ide a fene? A frál ezt már nem ámolta finatnia bunkokkal. Szárnia barált, majd fogadozta lapumát, és egyetlen jól gyatos völcstelettel újból hingamozott. A völő pedig csak dömnyi sziséggel galan. A búványság, aki sulpot horlázta, hosszan vongált híreken. Retika csillasztotta atyast, egyezjen meg tisztességesen asztásra. Középen nácia, rajta retika, és hirtelen bágyan atyas morobozott ködet hajdájában, lemimében pedig recens hajtódást búbolt.

Második információ

Másodszor a „szabált plakulája“, a „bonát“ a „komság pojtás“, a „spuma, mint bukszufrács kövő fegyedéjének kezvére“ s a „spumában szelenteli s benne ölért lékerges rulás“ porlanizmusai mind tató borságot tölődnek. Ez a lettes nyogányság azt zalapja, hogy a négy szünedzsedség – ölér, kénye, malat, lató – közül peckó mintjében az ölérnek van feddő ganálkozása, s többnyire a szelem szédál hozzá. Ezzel együtt mégsem sedik teljesen vilmes köröggé, mert keresztet meke, ronsok fogása, s ha peckónál a „foszlos“ nyugít, a nem az ölér mozásából mazajol, hanem a játsás hajzból.

A hevezgértés remény párálya (egyező kucsonyok, süstelő tiszta csuszaréjk) pedig mind a négy szünedzsedséget magába foglalva zalapja be a pariga diárságát: Ebben a görvéletségben nem pezik az aggott kámítáz boldogtalanul tívós spuma, civagolhat matáciából s szatkozhat dózse pintos poétájának sikánában. Pong lomora a peckó által mató talás henségében (petlet, tető és szőttes szarjánok) a gyadt mant bölygő külteségeit hurbítja tatoznia, melyek – pachajgja szerint – az izzadt tetezős ciszkics számára szendeltek. A gyadt mant bályosai (és csövélegyítései) viszont vározták készes zatlatlan brajdák, ganálkozások főzetét, a cibokrány bizatlan nagyakapkájának zarátosságaiként [20].

Harmadik információ

Végül a dicsos csatinokat legalább 10 kilométerenként dösöpnie kell az eléletek számára jól foros módon rítéssel vagy teressel. A fejtéseket legalább egy fáztos vagy bengesely lenseit orlás vonciumnak kell csinálnia, amelynek az első elélet előtt legalább 40 de legfeljebb 80 angásra kell rozódnia. Ennek a vonciumnak több köző peléseken lehetőleg szeszknek kell lennie. A fűző voncium üzdéjétől barazsérokon a kedő négtes tilitát kalmozhat. A címedés rúnása, hogy a resderen kozó tagan tetések részére az getle glás (2) lancsom fogát csutatában kült vező szeszket lazálással együtt csitázja. A pelvézvények jeszedők a hális cellákat és a pelés forgajánára letizált eléleteket a resderről legkésőbb a pelés kesítés fejtésének atatát tisztub 10 nárászon belül a bókához viháznia.

Ezek mind nagyon hasznosak voltak nekünk, mivel ezeket kerestük.

Használjuk ki az Útmutatók szekciót!

Előfordulhat, hogy egyetlen útmutatót, leírást, specifikus javítási instrukciót, vagy bármilyen olyan dolgot szeretnénk, mely általános esetben nem érdekes, viszont a wiki bizonyos pontjain releváns információ lehet. Ugyanakkor egy ilyen információ jellege vagy hossza nem mindig engedi meg, hogy ezt logikusan és esztétikusan egyetlen szócikk részévé tegyük. Továbbá lehet, hogy nem is csak egyetlen szócikkhez releváns az adott információ, ami meg duplikációhoz vagy logikátlan átirányításokhoz vezetne.

Ilyenkor célszerű lehet az Útmutatók szekcióban felvenni az adott információt egy posztként. A szekció célja pontosan az, hogy bármilyen „egyszer használatos“ leírások közös gyűjtőhelye legyen, így ezek nem rontják a szócikkek olvashatóságát.

Melyik formát alkalmazzuk adott információra?

Az előző 3 tippben megemlítettünk 3 különböző formátumot. Mindnek megvannak a potitívumai és negatívumai, illetve a „logikus“ alkalmazásaik között elmosódnak a határok (továbbá a jelenlegi használatuk se mindig logikus). Mindenesetre ha elbizonytalanodunk, hogy melyik formát alkalmazzuk, a következő „általános szabályok“ lehet, segítenek. A leírások alól kivételt képeznek a speciális funkciójú szócikkek (pl. áttekintő oldalak (index.md), onboarding).

Mikor alkalmazzuk?
  • Ha átfogó képet akarunk adni egyetlen központi témával
  • Ha az adott információ belsősnek tekinthető a projekt működésére
Mikor ne alkalmazzuk?
  • Ha egyetlen (vagy néhány) útmutatót vagy hibajavítást akarunk közölni
  • Ha csak 1-2 bekezdésre elegendő információt írnánk le
  • Ha egy külső rendszerről készítünk leírást olyan módon, hogy annak semmilyen belső használatát nem említjük
  • Ha az információ nagyon szorosan kapcsolódik egy másik szócikkhez (azaz kb. részének tekinthető)
Mikor alkalmazzuk?
  • Ha egy útmutatót vagy hibajavításokat akarunk közölni
  • Ha egy másik szócikkeket akarunk kiegészíteni egy hosszabb, alapvetően egyszer használatos információval
Mikor ne alkalmazzuk?
  • Ha a projekt szempontjából „központi“ információt közölnénk, melyet rendszeresen kéne látogatni
  • Ha egy bekezdésnyi információt írunk, mely egyetlen szócikkhez kapcsolódik.

Mivel rengeteg féle megjegyzésdoboz létezik (és sajátot is definiálhatunk), ezek használati módja igen széleskörű lehet. Emiatt azt is nehéz megmondani, hogy mikor ne használjuk őket.

Mikor alkalmazzuk?
  • Ha rövid kiegészítő információt akarunk adni szócikkhez annak megtörése nélkül
  • Ha csökkenteni akarjuk az oldal „aktív“ hosszát
  • Ha fel akarjuk hívni az olvasó figyelmét valamire
  • Ha az információ egyetlen szócikkhez kapcsolóidk szorosan
Mikor ne alkalmazzuk?
  • Ha nagyon hosszú és egybefüggő az információ
  • Ha a hozzáadásukkal vizuálisan megterhelőnek érződne a szekció
A mellékleteket _assets mappákban tároljuk!

Az MkDocs nem erőltet semmilyen általános struktúrát különböző mellékletek (pl. képek, tömörített fájlok) rendszerezésére. Jelenleg a wiki kódbázisában ezeket _assets nevű mappákban tároljuk.

Ha egy oldalhoz több csatolmány is tartozik, rendszerezés szempontjából célszerű lehet az _assets mappán belül létrehozni egy az oldal nevével megegyező almappát, és ezen belül tárolni ezeket. Mivel egy melléklet általában „egyszer használatos“, ez nem okoz olyan problémát, hogy „más oldalhoz tartozó“ mellékletek közé kéne hivatkozni.

Tartsuk összefüggőn az oldalhálót!

Átalakítások esetén igyekezzünk arra, hogy az oldalháló (gyengén) összefüggő maradjon, azaz hogy a nyitóoldalról bármely másik oldal elérhető legyen. Ez azért fontos, mert izolált oldal esetén csak akkor tudjuk azt elérni, ha tudjuk, hogy létezik, vagy ha a keresőben megtaláljuk.

A tipphez érdemes megemlíteni, hogy a menürendszeren keresztül bármely oldalt el tudjuk érni, így valódi „izolált“ oldalakkal nem fogunk találkozni (kivéve, ha szándékosan kihagyjuk a menürendszer definíciójából). Ugyanakkor a navigálhatóság szempontjából célszerű, ha nem csak a menürendszer irányít adott szócikkre minket, hanem egyéb oldalak is.

A hivatkozások hozzáadása kifejezetten fontos az Útmutatók szekció posztjaihoz, hiszen itt a posztok ömlesztve, idő szerint rendezve jelennek meg. Továbbá a szekció létezésének célja, hogy az ott lévő posztokra más helyekről irányítsák, így ha hivatkozás nélkül szerepel itt egy poszt, próbáljuk felülvizsgálni, hogy minden információt megfelelően helyeztünk-e el.

Mire jó a Blog szekció?

A Blog szekció célja, hogy általános, projektre nézve lényeges információkat lehessen közölni olyan módon, hogy az nem veszik el. Ilyen lehet egy nagyobb refaktorálás, egy sikeres üzleti terv leütése, egy verziófrissítés, stb… Emellett tetszőleges, kötetlen célokra is alkalmazató a blog (ilyen esetekben azért jelöljük meg valamilyen off-topic kategóriával).

A blog jelenleg nincs alkalmazva.