Click here to Skip to main content
15,892,746 members

Welcome to the Lounge

   

For discussing anything related to a software developer's life but is not for programming questions. Got a programming question?

The Lounge is rated Safe For Work. If you're about to post something inappropriate for a shared office environment, then don't post it. No ads, no abuse, and no programming questions. Trolling, (political, climate, religious or whatever) will result in your account being removed.

 
GeneralRe: Creating useful Technical Documentation for a project Pin
Bajaja9-Jun-17 3:37
professionalBajaja9-Jun-17 3:37 
GeneralRe: Creating useful Technical Documentation for a project Pin
Gerry Schmitz9-Jun-17 5:34
mveGerry Schmitz9-Jun-17 5:34 
GeneralRe: Creating useful Technical Documentation for a project Pin
Atle Bjanes9-Jun-17 6:00
Atle Bjanes9-Jun-17 6:00 
GeneralRe: Creating useful Technical Documentation for a project Pin
phuhn9-Jun-17 8:38
phuhn9-Jun-17 8:38 
GeneralRe: Creating useful Technical Documentation for a project Pin
Lucas Vogel9-Jun-17 8:38
professionalLucas Vogel9-Jun-17 8:38 
GeneralRe: Creating useful Technical Documentation for a project Pin
Retired201711-Jun-17 8:27
Retired201711-Jun-17 8:27 
GeneralRe: Creating useful Technical Documentation for a project Pin
Herbie Mountjoy13-Jun-17 9:02
professionalHerbie Mountjoy13-Jun-17 9:02 
GeneralRe: Creating useful Technical Documentation for a project Pin
kummaz11-Jun-17 13:48
kummaz11-Jun-17 13:48 
In addition to the usual architecture diagrams and documentation, I've taken to creating a small Knowledge Base (ours can be partitioned, so I create one for the particular project). Then I walk through and put all the common issues I've come across, or gotchas that I can think of in this Knowledge Base. Typically we start hand over a bit earlier than the cut-over date and any questions that the support team have, I can put these into the KB and then have the support team use that.

Whatever it can't answer, I will and then update the KB for them. It can be time consuming but I think it helps greatly as people can simply 'google' the answer for a particular error or question about the system. It depends how nice you want to be to the people you are handing the project over to I suppose Smile | :)

I also do this when I have been handed a system to support and have no supporting documentation. Creating a KB and putting new articles in any time I encounter a problem helps as I am forced to dive deeper into an issue and fully understand how it works.
GeneralWSO CCC OTD 2017-06-08 Pin
OriginalGriff7-Jun-17 21:59
mveOriginalGriff7-Jun-17 21:59 
GeneralRe: WSO CCC OTD 2017-06-08 Pin
LabVIEWstuff7-Jun-17 23:41
LabVIEWstuff7-Jun-17 23:41 
GeneralRe: WSO CCC OTD 2017-06-08 Pin
OriginalGriff8-Jun-17 0:09
mveOriginalGriff8-Jun-17 0:09 
GeneralRe: WSO CCC OTD 2017-06-08 Pin
LabVIEWstuff8-Jun-17 0:29
LabVIEWstuff8-Jun-17 0:29 
GeneralRe: WSO CCC OTD 2017-06-08 We have a winner! Pin
OriginalGriff8-Jun-17 0:30
mveOriginalGriff8-Jun-17 0:30 
GeneralRe: WSO CCC OTD 2017-06-08 Pin
pkfox8-Jun-17 1:25
professionalpkfox8-Jun-17 1:25 
GeneralRe: WSO CCC OTD 2017-06-08 Pin
OriginalGriff8-Jun-17 1:53
mveOriginalGriff8-Jun-17 1:53 
GeneralRe: WSO CCC OTD 2017-06-08 Pin
LabVIEWstuff8-Jun-17 2:35
LabVIEWstuff8-Jun-17 2:35 
GeneralDigital Fulfillment Pin
GenJerDan7-Jun-17 19:49
GenJerDan7-Jun-17 19:49 
GeneralFace Recognition Software Pin
C-P-User-37-Jun-17 17:24
C-P-User-37-Jun-17 17:24 
GeneralRe: Face Recognition Software Pin
dan!sh 7-Jun-17 17:38
professional dan!sh 7-Jun-17 17:38 
GeneralRe: Face Recognition Software Pin
Pete O'Hanlon7-Jun-17 21:08
mvePete O'Hanlon7-Jun-17 21:08 
GeneralRe: Face Recognition Software Pin
Nelek7-Jun-17 19:25
protectorNelek7-Jun-17 19:25 
GeneralRe: Face Recognition Software Pin
Jörgen Andersson7-Jun-17 19:44
professionalJörgen Andersson7-Jun-17 19:44 
GeneralRe: Face Recognition Software Pin
Kent Sharkey7-Jun-17 19:56
staffKent Sharkey7-Jun-17 19:56 
GeneralRe: Face Recognition Software Pin
Slacker0077-Jun-17 23:55
professionalSlacker0077-Jun-17 23:55 
GeneralMob programming Pin
R. Giskard Reventlov7-Jun-17 9:33
R. Giskard Reventlov7-Jun-17 9:33 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.