(Hur) Dokumenterar ni era projekt?

[90kar08]

Ofta när jag håller på med något projekt så tappar man farten efter ett tag, kanske ett annat projekt verkar
mer intressant så man lägger det första åt sidan till exempel. Sedan efter ett år eller två kanske man hittar
det där projektet igen och vill fortsätta men då har man ju såklart glömt hur man tänkte och hur allt hänger
ihop vilket resulterar i att man mer eller mindre får börja om från början igen. Jag brukar spara på alla scheman
osv som jag ritar och ofta hjälper det mycket om man gör en projekttråd här på EF.

Jag funderar på om man skulle göra en liten mall där man under projektets gång enkelt kan fylla i ett namn på
projektet, vilka funktioner den färdiga "produkten" ska ha, vilka som fungerar, vilka problem dom uppstår och
löses, vilka filer (ex. kretskortslayouter, programkod osv) man har på datorn osv. Denna mall kan man sedan
antingen sätta under en flik i en pärm med annat som är relaterat till projektet eller lägga i en mapp på datorn
tillsammans med alla andra filer som hör till projektet. Lägger man det på datorn gäller det att scanna in allt
handskrivet och lägga i samma mapp, annars är det ju kört igen...

Hur dokumenterar ni era projekt?

[Klas-Kenny]

Scheman och layouter sparar jag alltid på datorn, har varje schema jag någonsin ritat i en mapp på Dropbox.
Sparar även alla olika versioner av scheman och layouter. Tar ny version från det att jag gör ett mönsterkort, och skriver med rev-note med vilka förändringar som gjorts.
(Bygger sällan eller aldrig ful-byggen på veroboard eller liknande, ritar alltid schema och gör mönsterkort)

Programkod sparar jag också all. Även där, alla versioner. Tar ny version från det att jag anser grejen färdig, gör jag sedan några förändringar en bit in i framtiden tar jag det som ny version (rätt sällan det händer dock).

Enda problemet som kan orsaka lite förvirring är det att jag inte alltid vet direkt vilken kod som hör till vilket schema. Det händer att jag inte har något riktigt bra namn på projektet, och det får olika namn i schema och programkod. För jag har en mapp med scheman och layouter (undermappar för varje projekt) och en mapp med programkod (undermappar för varje projekt), det bästa vore kanske att ha projektmappar med allt som hör till ett projekt i samma.
Särskilt när det kommer till mekaniska ritningar också blir det ofta lite rörigt, då de ritningarna är i ytterligare en mapp.

Har dock blivit betydligt bättre på att namnge mina projekt, då det problemet blir mindre och mindre.

[JimmyAndersson]

Först och främst så fotograferar jag i princip alla projekt.
Då är det enkelt att gå tillbaka och titta på t.ex:
Finns det mer plats i chassit för en påbyggnad?
När gjorde jag den här grejen?
Vad valde jag för kontakter, vad sitter det för minnen i, osv.
Dessutom är det kul att gå tillbaka och se hur projektet växte fram.

Jag har även projekt-mappar. T.ex det jag avslutar just nu:
E:\Projekt 2012 - 2013\Pannlog Styrning\

Där finns scheman (i bild-format), textfiler med pinout för alla anslutningar,
Photoshop-bilder på hur resultatet ska se ut, mallar, mm.
Jag gör även Photoshop-bilder för att underlätta t.ex lödning av en massa sladdar.
(När man har lött en sladd så målar man över motsvarande ledare i schemat med grön färg.)
Mycket praktiskt!

Alla scheman finns även i den vanliga Eagle-mappen.
Jag har olika mappar för källkod. En för Visual C#, en för allt PIC-relaterat, osv. T.ex:
E:\PIC\ASM\PIC18F2320\MIDI-pedal2\


Egna (eller andras) standarder över t.ex vilken ledare som är DQ i 1Wire-kabeln,
eller hur vissa kablar är dragna, protokoll (mjukvara), osv finns i pärmar.
De pärmarna är min egen standardiserings-organisation.

Så med mina bilder och pärmar kan jag kolla upp allt tänkbart.
Jag använder även Elektronikforumet för att söka upp en del grejer jag skrivit/fotat.




Däremot dokumenterar jag inte projekt som sitter på labplattan förrän de är klara.
Ibland kan det bli ett foto, men det blir så rörigt med tvådimensionella bilder av en massa sladdar.
(Jag har gjort 3D-bilder ibland. Det är ett mycket bättre hjälpmedel.)

Så man kan bli lite fundersam när man plockar fram en labplatta med ett oavslutat projekt...
Därför har jag tre hyllor på olika ställen i lab-rummet där jag får lägga oavslutade lab-uppkopplingar.
Då kommer man ihåg att t.ex på hyllan vid dörren ligger labplattan för fjärrstyrningen av kameran.

[Lennart Aspenryd]

Utomordentligt viktig tråd.
Kom bara ihåg att sätta datum för förslag på förändringar i specen.
Och allmänna synpunkter.
Vad vi tycker och tänker ändras

[ensten]

Jag använder Evernote. Funkar jättebra eftersom man kan ladda upp filer (ex. bilder, scheman, kodfiler osv).

Så här kan de se ut:

Skärmavbild 2013-10-17 kl. 18.48.03.png

På köpet så får man synkronisering till andra enheter. Begränsningen för gratisversionen är 60MB per månad vilket kan bli lite snålt. En premium kostar mellan 300-400,- kronor/år då får man 1GB/månad

[psynoise]

Jag försöker alltid skriva en rapport i samband med utvecklingen i klassisk stil med systemspecifikation först och sedan systembeskrivning i top-down. Nyligen har jag även börjat göra allt med Subverion mot en server här hemma. Väldigt smidigt och med publik internetadress når jag mina projekt överallt.

Sedan är jag lite av typen som hellre utreder problem än att bygga ihop något. Detta har resulterat i många dokument med beräkningar över lite allt möjligt. Med god ordning kommer mycket till användning igen.

[Electricguy]

Dokumentera? Hur gör man då?
Jag brukar "rita" upp i huvudet vad jag vill göra och hur jag vill göra det, och sen bygger jag bara..

[Marta]

Källkoden till MCU och eventuella tillhörande program i PC är alltid välkommenterade. Kretskort o.dyl. har bara mönstret i en cad-fil. Sedan fotograferar jag det färdiga och monterade kortet. Allt kladd på papper sparas också och är det viktigt scannas det in. Allt som hör till en viss konstruktion grenas ut från samma directory. Har fungerat bra hittills, bara backupen blir skött som den skall...

[90kar08]

Bilder är väl det enda som jag har riktig ordning på, i min bildmapp på datorn har jag en mapp som heter "Projekt".
I den har jag en undermapp för varje projekt. Men för projekt som inte kommer längre än till breadboard blir det
ofta inga bilder. Och sen blir det ju som för er andra att alla kretskortslayouter ligger i Diptrace-mappen och alla
PIC-program ligger i en annan mapp, osv...

Känner att det är dags att bli lite mer organiserad men jag känner också mig själv tillräckligt för att veta att det
inte räcker med att bestämma mig för att bli bättre utan jag behöver ett konkret tillvägagångssätt som funkar
för alla storlekar på projekt för att det ska bli något av det. Dessutom måste det vara enkelt att utföra.

Ju mer jag tänker på det så inser jag att lösningen är att ha en projektmapp (kanske till och med en egen hårddisk)
med en undermapp för varje projekt där allting läggs, även programkod, layouter och handritade grejor, tillsammans
med en kort text- eller word-fil med beskrivning av projektet. Det är nog bäst med en word-mall så att det finns
färdiga fält att fylla i, annars blir det nog inte av. Helst skulle ju det här ligga i typ Dropbox så att man kan komma
åt det både på laptopen och den stationära datorn var man än är men då kommer ju inte allt få plats

Sen gäller det bara att inte tillåta sig själv att påbörja ett projekt utan att skapa en ny mapp och åtminstone fylla
i word-mallen med de mest grundläggande sakerna.

[ylle]

Är alldeles för dålig på att dokumentera.
Försöker att döpa alla filer ordentligt och lägga allt i rätt katalog. (hmm, hmmm, hmmmm, kanske, kom ihåg, viktigt är inte bra namn)
Backupen är det absolut viktigaste, minst hälften av allt gammalt har försvunnit pga ominstallationer och trasiga hårddiskar.
Dropbox och ett usbminne kör jag med nu. Är det nåt väldigt viktigt brukar jag maila mig själv en kopia.