2019-04-12

Mars/April 2019 - Dokumentera mera, dokumentera allt!

Hur många kommer ihåg hur man gjorde en viss uppgift för 2 år sedan eller vad man gjorde för att lösa ett problem med någon applikation som spottade ur sig ett felmeddelande för några månader sedan? 

När jag arbetar så har jag funnit hur oerhört viktigt det är att dokumentera det man gör. Utan dokumentation är det svårt att veta vad man tidigare gjort och hur man tänkte då man gjorde det. Sen händer det ganska ofta att man börjar jobba med något som man tvingas avbryta för att sen dagar eller veckor senare ska starta upp igen. Då måste man ofta göra om allt man gjorde första gången.

Därför skapar jag dokument direkt. Det brukar börja med ganska ostrukturerad information där jag bara lägger till texter, länkar, kod etc efter hand som det kommer. Om det senare är något som är värt att spara så renskriver jag det i ett nytt dokument som läggs till dokumentationen. Om det inte är värt att renskriva så brukar jag ändå spara dokumentet och en folder döpt till "arkiv". Man vet aldrig när det kan komma till nytta i framtiden.

För större saker som jag direkt vet kommer bli en instruktion eller processbeskrivning så strukturerar jag det bättre. Oftast punktlistor. Gärna med mycket länkar till där jag hittade informationen. Exempelvis så finns uppsättning av webbhotellet in i minsta detalj beskrivet för att jag snabbt och enkelt ska kunna konfigurera en helt ny server. Varje gång jag ändrar någon konfiguration så uppdaterar jag relevant dokument med den informationen.

Jag har även ett dokument med lösningar för olika problem som dyker upp på webbhotellet. Det finns oftast ett felmeddelande och det leder sedan till en lösning. Nästa gång samma eller liknande felmeddelande dyker upp så kan jag enkelt göra en sökning på det i min dokumentation och hitta lösningen och de länkar jag använde för att lösa problemet.

Från början dokumenterade jag allt i ett privat forum som bara jag hade access till, men efter några år tyckte jag att det var väldigt omständligt att göra ändringar, backuper tog tid och forumet var tvunget att uppdateras hela tiden för att inte låta några säkerhetshål finnas kvar som kunde förstöra forumet. Därför flyttade jag allt till Google Drive

Google Drive är i princip en hårddisk online eller i molnet som man säger, men det är också så mycket mer. Google har sina egna dokumentformat som inte tar något utrymme alls så det är väldigt fördelaktigt att skriva allt i Google Dokument eller Kalkylark. Jag har ändå köpt till utrymme för att kunna lagra alla mina foton där (jag är medveten om Google Photos som jag också använder, men foton hanteras inte på det sätt jag vill där).

Utöver lagringen så sköter man även allt skrivande direkt i webbläsaren. Alla ändringar sparas blixtsnabbt direkt i dokumentet utan att man behöver tänka på att spara. Det finns för övrigt inte ens någon funktion för att manuellt spara utan det sköts automatiskt.

En mycket kraftfull funktion är att man kan vara flera personer samtidigt inne i ett dokument och göra ändringar precis samtidigt. Det är bara att dela dokumentet med de personer som ska få göra ändringar. Det går även att begränsa access till att bara titta på dokument och göra kommenterer.
Jag använder det här väldigt mycket i de olika organisationer jag är med i som idrottsföreningar och företag. Det gör att alla som behöver tillgång till ett dokument kan göra ändringar utan att dokument lagras hemma på folks datorer och riskerar att komma bort eller bli förstörda.


System och tjänster som uppdaterats sedan förra uppdateringen:
  • s04
    • Autokonfigurering av epostinställningar är nu aktiverade. Om din epostklient har stöd för det så hämtas rätt inställningar från mailserverna och konfigurerar din epostklient. Testa gärna och se hur det fungerar.
    • Minnesproblemet är äntligen löst. Det som löste det var att konfigurera PHP-FPM (FastCGI Process Manager - Den sköter exekveringen av PHP-kod) med bättre värden. Anledningen till att minnet tog slut var att antalet barn som varje PHP-FPM-process kunde starta default var satt till 9999. Det gjorde att om en sida hamnade under hård press exempelvis vid en attack så spawnades mängder med nya barnprocesser som var och en drar cirka 500 MB. En enda site kunde då uppta 5 TB av RAM-minnet. Nu är värdet satt betydligt lägre (50) och barnen dör snabbare när de inte använts på ett tag. Det går att tweaka varje site individuellt så om det behövs går det att öka vissa och minska vissa beroende på hur aktiva besökare man har.