Interdoc - interaktiv dokumentation

Tanken är att skapa ett system för dokument som också gör det lätt att uppdatera. De krav jag har är:

• Ska vara lätt att skriva nya texter.
• Lätt att uppdatera.
• Lätt att fånga upp sporadiska tankar.
• Lätt att samla detaljerade planer och specifikationer för system.
• Underlätta självreflektion.
• Lätt att hålla reda på saker som ska göras och sådant som är avklarat (att-göra listor eller på Engelska, todo-listor).

Dokument-systemet är interaktivt i den mening den underlättar uppdatering av innehåll. Systemet hjälper till att strukturera och kategorisera aspekter av ett projekt. Det i sin tur underlättar reflektion och att kunna arbeta långsiktigt med ett projekt och dess olika aspekter utan att behöva ha allt i närminnet.

Dokument-systemet ska uppmuntra till självreflektion för att identifiera ineffektivitet och hitta bättre metoder och förhållningssätt. Därför ska systemet också vara en plats att skriva ner självreflektioner kring den kreativa processen reflektioner kring ens egna varande ur ett helhetsperspektiv, i relation till projektet, eftersom en själv är utgångspunkten för allt kreativt arbete.

Denna sajt (matkalkyl.dev) är i grunden ett dokumentationssystem som jag använder som stöd för att utveckla sajten i fråga.

...

En del av att utveckla system är att skriva ner systemets egenskaper samt vilka beslut som tagits och varför. Då kan jag återgå senare och lätt förstå saker och ting. Ett bra dokumentsystem uppmuntrar mig också att tänka och resonera mer innan jag skriver själva programkoden. Att dokumentsystem är "integrerat" betyder att det är anpassat till mina enheter och de andra verktyg jag har. Exempelvis när jag uppdaterar något via telefonen i min texteditor (Obsidian) så blir det direkt synligt på denna webbsida.

Jag använder Syncthing som synkroniserar alla dokument mellan dator, telefon och webbserver. Syncthing kan synkronisera allt mellan olika enheter och rekommenderas.

Jag använder Obsidian (mobil) främst för att anteckna och redigera idéer via mobilen, samt hantera todo-listor. Obsidian skapar enbart md-filer vilket är vanliga textfiler med "markup" syntax och allt i vanliga kataloger. Det gör det lätt att integrera med andra syste (dvs inga word-dokument som vara kan läsas av vissa program).

Webbservern är programmerad att visa dessa md-filer och utgår från hur jag har kategoriserat innehållet via Obsidian. En av styrkorna i Obsidian är att enkelt kunna länka filer med varandra baserat på ordval. Jag har delvis integrerat den funktionen på webbservern. En fras eller ett ord länkar till motsvarande dokument. Exempelvis ordet "dokumentsystem" länkar automatiskt till denna sida i mitt fall. Detta underlättar att presentera innehållet på ett mer navigerbart sätt vilket gör det enklare att överblicka och roligare att skriva. Att presentera information, vilket jag gör på denna webbsida, är också ett bra sätt att motivera sig själv att strukturera informationen bättre. Välstrukturerad och övervägd information är behjälplig när ett system växer i storlek.

Alla kreativa sysslor som kräver långvarigt engagemang inbegriper ett arbetsflöde, "workflow" på Engelska.

Todo

• [ ] Filtrera med parsedown på mimiststus-text.