Voorbeeld systeemdocumentatie

[Anoniem: 27441]

(Valt deze post onder SA???)

Ik ben op zoek naar voorbeeld systeemdocumentatie. Ik moet voor onze websites namelijk een technische en een gebruikershandleiding schrijven. Bah, maargoed...

Is er iemand die hier een voorbeeld van heeft? Ik zou eerlijk gezegd niet weten aan welke richtlijnen en opzet ik me zou moeten houden.

[djluc]

Je zou eens kunnen beginnen met een featurelist, een algemene beschrijving van het systeem en een handleiding voor de mogelijkheden? Verder zou je natuurlijk eens kunnen kijken wat de professionals er van maken zodat je daaruit ideeën op kunt doen.

[mutsje]

Zoiets noemt men ook wel OM(operations Manual)

Wat je hierin zet zijn.
welke services automatisch starten met welke accounts
je backups hoe dit loopt.
specifieke instellingen van de server
etc.

Verder moet je alles wat er getweaked is beschrijven in het document zodat bij een crash aan de hand van de documentatie de boel herstelt zou kunnen worden.. niet dat dit realistisch is maar helpt je toch goed op weg..

[Anoniem: 27441]

Thanks.

Het voelt als een complete waste of time. Ik ben op het moment de enige die de websites bijhoudt / ontwikkeld. En zo gecompliceerd zijn de websites nu ook weer niet. Alleen onze kortingsstructuur is ingewikkeld.

Jullie kennen dat gevoel vast ook wel. Iets zo tegen je zin in moeten doen dat je er omheen gaat draaien. Nou ja, laten we maar beginnen!

[Jazzy]

Anoniem: 27441 schreef op 07 October 2003 @ 08:53:
Thanks.

Het voelt als een complete waste of time. Ik ben op het moment de enige die de websites bijhoudt / ontwikkeld. En zo gecompliceerd zijn de websites nu ook weer niet. Alleen onze kortingsstructuur is ingewikkeld.

Al Capones?

Jullie kennen dat gevoel vast ook wel. Iets zo tegen je zin in moeten doen dat je er omheen gaat draaien. Nou ja, laten we maar beginnen!

Ja, ik ken dat. Mijn ervaring in dit geval is dat ik gewoon een paar punten op een kladpapiertje zet. Als je dan nog begint met een inleiding (dit document gaat over blablabla, de reden is dat blablabla) en een paar duidelijke hoofdstukjes dan wordt het zo een aardig documentje.

Je kunt ook een paar screenshotjes opnemen wanneer dat relevant is. En als laatste even aan een collega laten lezen en om kritiek vragen.

(Valt deze post onder SA???)

Als je echt serieus met dit onderwerp bezig bent dan kun je eens overgwegen om in PNS te posten. Daar hangen veel figuren rond die meer ervaring hebben met dit soort zaken. Wel even overleggen met de mods want je zult in ieder geval met een betere startpost moeten komen.

[ Voor 16% gewijzigd door Jazzy op 07-10-2003 09:04 ]

[momania]

Ik denk dat er evengoed zat te vinden is qua systeem documentatie.

Kijk bijvoorbeeld eerst eens bij de applicaties die je op je pc hebt draaien. 9 van de 10 keer zit daar documentatie bij en daar heb je dan al een mooi voorbeeld aan.

Verder lijkt het me handig dat je bij het schrijven van die documentatie gewoon blijft denken: "wat zou ik er zelf in terug willen zien?"