Projektvy

Doc

Status: checkout idag
Mängd: 13h 02m totalt

doc:

System, princip, disciplin och metod för hur dokumentera källkod och annat. Utan dokumentation är det svårt att förstå och underhålla programkod. Dokumentation är basal komponent i alla projekt men ofta dåligt implementerad med allt från obefintlig och förvirrande till onödigt expressiv och tidskrävande. Syftet här är att lägga grunden för en personlig tradition för dokumentation. Min personliga dokumentationsrutin har varit mycket knapphändig, men Linux är bästa miljön för att utveckla det, eftersom den som saknar struktur och personlig dokumentation straffas hårt via oväntade och självförvållade systemfel. Samma princip gäller dock inom programmering generellt sätt. Dokumentering tar lite mer tid men sparar mycket tid i längden. Den kloke förstår att dokumentation inte bara handlar om att beskriva saker, men att träna ens bedömmningsförmåga i att avgöra ett fenomen och kategorisera dess innehåll, vilket tränar förmågan och vanan att upprätthålla ett mer medvetet förhållningssätt till sin omgivning där ett fenomen förstås mer än det antas. Via ökad förstålese uppstår en högre grad av system-intuition för hur systemen kan utvecklas vidare. Dokumentation är därmed också ett sätt att träna upp perception (hur vi förstår världen) vilket gynnar tankeförmåga och handlingskraft.


  • Tog mer tid än planerat, men det blev bra och är en fundamental komponent som kommer bestå och fortsätta förbättras över tid. Systemet är halvautomatiskt och uppdateras i enlighet med min programkod.


  • Färdigt gränssnitt för referensmaterial som projektet generear och behövs för att kunna förstå, utveckla och underhålla systemet. Jag kunde inte integrera det i min terminal-miljö inom rimlig tid så jag gjorde ett WebUI istället. ChatGPT gjorde dock en Vim-key kompatibelt läge för mig i textarea-elementet (ytterst basalt men tillräckligt).


  • Hur har jag i skrivandets stund lyckats förlora 4 timmar på detta? Känns orimligt. Tidsuppfattningen har påverkats. Fälla med AI. Vissa problem kan den inte lösa, men skapar en känsla av att du nästan har lösningen och man försöker igen och igen men får bara mer problem. AI är bra för göra häst-jobb, att utvärdera referensmaterial, och för reflektion men inte för att förlita sig på. Behöver motverka detta beteende mönstret att fastna i AI.


  • Skapa en gammal hederlig Web-lösning som "fallback-lösning". Jag måste ha ett dok-system för källkod. Skapa ett WebUI för dokumentering som körs i webläsare paralellt. Dokumentation är ändå mer av konceptuellt tänkande och är inte beroende av hypereffektiva tangentbordskommandon, även om det är trevligt.


  • Avbryter det försöket att skapa 100% integrerad lösning. Jag saknar domänspecifik kunskap (Tree-sitter m.m) för att kompensera för AI's svårighet att lösa det. Jag löser det "fint" i framtiden i mån av tid och behov.

Visa alla

Tillbaka till framsidan