Nieuwe programmeurs - structuur en kennisoverdacht

[Martijn19]

Hoi mensen,

Ik weet niet 100% zeker of dit het juiste subforum is voor mijn vraag, maar aangezien alle technici hier zitten zullen jullie vast kunnen meedenken.

Ik heb een bedrijf in Singapore en ben de CTO/Lead developer (geef het een naam, als co-founder ben je alles totdat je de juiste mensen hebt). Het team bestaat momenteel uit 6 FTE, ik ben de enige die echt programmeert. Wij werken met blockchain technologie en de mensen hierin zijn schaars. Momenteel zit alle kennis dan ook exclusief bij mij.

Er zijn 15-20 repositories verspreid over Bitbucket (private) en Github (public) met vrij weinig documentatie. Daarnaast zit mijn Evernote vol met notities over installatie van servers, software, command line utilities en nog veel meer. Waar ik als developer altijd blij van wordt is goede documentatie en hier heb ik zelf natuurlijk een steekje laten vallen.

Hoe structuren jullie de kennis die momenteel in een bedrijf zit? Gebruiken jullie een interne wiki, staat alles in de Slack historie, gebruik je een blog, een PDF? Hiermee bedoel ik vooral dingen zoals developer guidelines (code, tests, communicatie) en waar mensen kunnen vinden wat ze nodig hebben (een aantal repositories zijn bijvoorbeeld libraries ter ondersteuning van de projecten).
Ook moet ik blockchain gaan uitleggen, een soort van wiki waar mensen videos, tutorials en tekst kunnen vinden lijkt mij ook handig. Hebben jullie zoiets als een interne wiki?

Daarnaast vraag ik mij af welke project management software jullie gebruiken? Van alle repositories moet natuurlijk de bugs en gewenste features bijgehouden worden en is het natuurlijk belangrijk om te zien wie waar aan werkt.

[Swedish Clown]

Kleine duit in het zakje maar Atlassian biedt een hoop van de tools waar jij om vraagt. Confluence voor de documentatie, JIRA voor het bijhouden van bugs, features etc. Integreren beide gemakkelijk met Slack indien je daar gebruik van maakt

[Martijn19]

Brakkie41 schreef op maandag 12 september 2016 @ 10:13:
Kleine duit in het zakje maar Atlassian biedt een hoop van de tools waar jij om vraagt. Confluence voor de documentatie, JIRA voor het bijhouden van bugs, features etc. Integreren beide gemakkelijk met Slack indien je daar gebruik van maakt

Je hebt gelijk inderdaad. Ik kende alleen Jira en had helemaal niet door dat ze ook knowledge base software aanbieden. Ik ga het eens bekijken.

[Avalaxy]

Wat betreft kennis over de blockchain zelf lijkt het me overdreven dit zelf allemaal op te schrijven. Iedereen een kopie van Mastering Bitcoin geven lijkt me het effectiefst: http://shop.oreilly.com/product/0636920032281.do.

[Martijn19]

Avalaxy schreef op maandag 12 september 2016 @ 10:27:
Wat betreft kennis over de blockchain zelf lijkt het me overdreven dit zelf allemaal op te schrijven. Iedereen een kopie van Mastering Bitcoin geven lijkt me het effectiefst: http://shop.oreilly.com/product/0636920032281.do.

Het gaat mij meer om hands-on voorbeelden en uitleg van onze blockchain software. Voor blockchain in het algemeen zijn er inderdaad genoeg goede boeken of videos te vinden.

[Hydra]

Martijn19 schreef op maandag 12 september 2016 @ 10:33:
Het gaat mij meer om hands-on voorbeelden en uitleg van onze blockchain software. Voor blockchain in het algemeen zijn er inderdaad genoeg goede boeken of videos te vinden.

Ik zou beginnen met een hoog-over architectuur beschrijving. Ben zelf wat dat betreft wel fan van de C4 methode van Simon Brown.

[MSalters]

Brakkie41 schreef op maandag 12 september 2016 @ 10:13:
Kleine duit in het zakje maar Atlassian biedt een hoop van de tools waar jij om vraagt. Confluence voor de documentatie, JIRA voor het bijhouden van bugs, features etc. Integreren beide gemakkelijk met Slack indien je daar gebruik van maakt

En met <10 man kost je dat $10 per Atlassian tool. No-brainer.

[Kettrick]

Brakkie41 schreef op maandag 12 september 2016 @ 10:13:
Kleine duit in het zakje maar Atlassian biedt een hoop van de tools waar jij om vraagt. Confluence voor de documentatie, JIRA voor het bijhouden van bugs, features etc. Integreren beide gemakkelijk met Slack indien je daar gebruik van maakt

Github biedt dat beide ook via issues en de wiki feature. Persoonlijk merk ik dat ik veel meer bezig ben met github dan met externe tools als confluence, trello, mingle etc.

Uiteraard zijn jira en confluence veel complexer maar het vereist meer discipline waar ik persoonlijk vaak moeite mee heb. Issues worden middels pull requests gesloten zodra de code klaar is, at past goed bij mij luiheid .

mbt nieuwe starters, ik heb zelf een hele eenvoudige eis, als ik ./run.sh uitvoer moet ik kunnen werken, zonder enige externe configuratie. In veel gevallen betekent dit dat alle afhankelijkheden etc in een docker container worden gestart etc. Dit simpele contract maakt dat je een stuk minder documentatie nodig hebt, code is uiteindelijk de beste documentatie en zodra je de environment-setup weghaalt wordt dat een stuk eenvoudiger.

[Swedish Clown]

Kettrick schreef op dinsdag 13 september 2016 @ 12:08:
[...]


Github biedt dat beide ook via issues en de wiki feature. Persoonlijk merk ik dat ik veel meer bezig ben met github dan met externe tools als confluence, trello, mingle etc.

Uiteraard zijn jira en confluence veel complexer maar het vereist meer discipline waar ik persoonlijk vaak moeite mee heb. Issues worden middels pull requests gesloten zodra de code klaar is, at past goed bij mij luiheid .

mbt nieuwe starters, ik heb zelf een hele eenvoudige eis, als ik ./run.sh uitvoer moet ik kunnen werken, zonder enige externe configuratie. In veel gevallen betekent dit dat alle afhankelijkheden etc in een docker container worden gestart etc. Dit simpele contract maakt dat je een stuk minder documentatie nodig hebt, code is uiteindelijk de beste documentatie en zodra je de environment-setup weghaalt wordt dat een stuk eenvoudiger.

Tuurlijk kunnen dit soort zaken ook lopen via issues en de wiki feature. Echter, ik werk in de financiële sector en in deze sector zijn enorm strenge eisen aan waar je code en documentatie gehost mogen worden en waar deze aan dienen te voldoen. Wij hebben hier dus een eigen Stash, JIRA, Confluence en nog een partij andere zaken lopen om te voldoen aan enkele van deze eisen cq. een bak gezeik te voorkomen.

Code is zeker de beste documentatie en zolang de documentatie in hetzelfde tempo ge-update wordt als de code, ben je snel "slechter" af met documentatie dan zonder. Echter documentatie is in veel gevallen gewoon nodig dan wel een vereiste.

[Mercatres]

Ons onboarding principe voor devs bestaat uit in eerste instantie zelf hun eigen laptop opzetten, samen met een aangeduide persoon waar ze sowieso altijd wel de nodige hulp voor kunnen vinden: een soort buddy. De technische uitleg over de structuur van de organisatie en de manier van werken komt dan van verschillende rollen: infrastructuur en security komt van mij, uitleg over Scrum, git en guidelines komen van resp. de scrum master en de technische teamlead. Tijdens de onboarding wordt er ook al uitleg gegeven over de online services (JIRA, Confluence en Bitbucket en nog enkele specifieke services voor ons kwaliteitsysteem en security) en daarnaar verwezen.