Slashdot Mirror


Best Practices For Process Documentation?

jollyreaper writes "I have a nice new IT job with a non-profit. They are a growing organization and management has realized that they need to bring their way of doing business up to a professional level. Several years back, their IT department was still operated like it was in a home office — fine when you're dealing with three people, not so good when there's over a hundred users. IT got its act together and is now running professionally and efficiently. The rest of the organization is a bit more chaotic and management wants to change that. One of the worst problems is a lack of process documentation. All knowledge is passed down via an oral tradition. Someone gets hit by a bus and that knowledge is lost forevermore. Now I know what I've seen in the past. There's the big-binder-of-crap-no-one-reads method, usually used in conjunction with nobody-updates-this-crap-so-it's-useless-anyway approach. I've been hearing good things about company wikis, and mixed reviews about Sharepoint and its intranet capabilities. And yes, I know that this is all a waste of time if there's no follow-through from management. But assuming that the required support is there, how do you guys do process documentation?"

10 of 370 comments (clear)

  1. Tough project by ccguy · · Score: 5, Insightful

    In order to (successfully) document all the processes in your company you are going to need support not only from management but from all the staff as well. This is going to be the most difficult thing to get.

    Forget about wikis and all technical solutions you can think of, for now. First, you need to explain everyone what they get by documenting everything. For most people, explaining what they do, how, etc, means to give away their value. I'm not saying it's true, it's just the way many people think, and this is why they refuse to cooperate as much as possible. Asking someone to document everything sounds like '...so we can replace you'. In particular, drop the 'hit by a bus' argument.

    So, your project is probably not to be about documenting everything, but probably about improving those processes as well, making life easier for everyone (and making it clear than that's the final goal), etc.

    Once processes are more or less defined (or redefined) with the participation of staff (meaning that they get to give feedback) you can implement a policy of 'all processes need to follow the documented procedure. Procedure can be changed if needed'. This will in turn help to keep your documentation updated.

    Anyway you are definitely going to need help from a change management specialist, human resources, etc.

    1. Re:Tough project by dltaylor · · Score: 5, Insightful

      Dead wrong.

      1) almost no one knows what knowledge others in their organization lack

      2) very few people really know how much they know

      3) almost no one ever has the time to catalog their knowledge and write it all down (if they do, they probably aren't doing anything and don't know anything)

      Pick something, for example, a set of personal wikis. Start a "test run". Every time someone is asked how to do something by someone else, they don't explain verbally, they put it in their wiki. Between the requester's follow-up questions (also through the wiki) and the answers, there will be the "oral history" captured electronically.

      Management has to provide the resources, and the startup training time, as well as some sort of recognition for those who answered "in form" and for the requesters that followed through "in form".

      One other thought is that "how I do X" could be captured through voice recognition. As a staff member performs a task, they could verbalize the steps to some easy-to-use voice recorder, then those recordings parsed to on-line documents. Allow the staff member first crack at editing as a courtesy (you don't know what was captured), and while they're doing it, they may also think of more input.

      Don't be a grammar Nazi on the wikis (or whatever tool). Save that for the professional training manual writer(s) that end up compiling the "official" procedure manual from the raw data.

    2. Re:Tough project by AndGodSed · · Score: 5, Insightful

      Well, the old adage goes "If you can't be replaced, you can't be promoted."

      If you can get the employees to take ownership of their jobs and see this as an opportunity to:

      a) Learn a new skill (especially for the non-tech savvy types)
      b) Reduce their work load
      c) Create an opportunity to expand their portfolio to the point they are promoted to run a department and/or administer a person that has been employed to do their old job,

      they should buy into this and support the idea.

      Unfortunately as with most great ideas the actual sale is more problematic than the implementation.

      In fact I'd say the sale is key.

    3. Re:Tough project by torkus · · Score: 5, Insightful

      Exactly. In the past I've made an effort to build a proces, document things, and get tedious/repetitive tasks off my plate. Did that make me redundant and cost me my job? No. It got bonus/promotion in the best case and at least an attaboy.

      If your job consists of doing something simple and/or repetative and you're the only one tho can do it because you're the only one who knows how...you job is already in jeopardy. Someone like me will eventually come in, simplify it and hand off to a lower paid person than you.

      It's the creative work...creating things/processes/documentation/ideas that get paid well. Manually pulling complex SQL queries that are pretty much the same every time will only last so long before a mid-level developer with something to proves writes a simple front-end and makes you pretty useless.

      --
      You can get rich if you own a politician, but you have to be rich to buy one in the first place.
  2. Operational manual by LiquidCoooled · · Score: 5, Funny


    (1) Avoid being hit by a bus.

    (2) Refer to 1.

    --
    liqbase :: faster than paper
  3. My experiences by Anonymous Coward · · Score: 5, Informative

    It's really hard to get people to write this kind of stuff. A wiki will work well for some people - developers and IT types particularly - but I've had mixed joy with non-technical types. I don't think it's the technology that's the problem, it's lack of desire to undertake the task and, in some cases, a wish to feel 'indispensable', which this process is trying to reduce. Some people find that very unnerving.

    Where there is no motivation for the group to start documenting, I personally try and lead by example. If I have a process or a system that would benefit, I write a small and clear document (I try and keep it to one side of A4, three at most) and store it on the network. Generally, it never gets looked at, but when somebody needs to know how to do something, it is there and they appreciate it. I also document other people's processes as and when I need to know what they do.

    After a while, and with some encouragement, people start to add their own documents and the whole thing starts to grow.

    It's difficult though. The worst thing is when you see a company that have invested a lot of time and money writing process documentation that is clearly useless. The danger here is having the false sense of security.

    It's also important to remember that the single biggest potential drain on a company is staff turnover, and this will always be the case, even if you have the best process documentation in the world. People are not cogs.

    That's my (limited) experience. Might also be worth noting that I'm not a manager, I'm a developer, so I am working with and influencing my peers rather than my minions.

    P.S. I hate Sharepoint and would not recommend it at all

  4. I say go the traditional route. by spazmonkey · · Score: 5, Funny

    You could come up with new ways, of course, but why rock the boat. Just go with the tried and true way of handling these things in American corporate culture; Mandate all employees must stay away from buses.

      To accomplish this is quite simple:

      1. Create new management positions and dept. to determine and create new compliance metrics for appropriate bus avoidance.
      2. Create committee to determine and define best practices for avoiding buses.
      3. Hire PR firm to create awareness of above policies and create slick training videos to introduce employees to anti-bus methodology.
      4. Create HR sub-department in charge of enforcement and compliance to metrics with appropriate disciplinary board and/or retraining.

      See. Simple. Problem solved.

  5. Re:My approach by youthoftoday · · Score: 5, Funny

    There is no 3 because it's a non-profit...

    --
    -1 not first post
  6. Too much good advice. by evanyares · · Score: 5, Insightful

    Want to know how to sort it all out? Get some sticky notes, and a whiteboard. Write down each suggestion on a sticky note, and stick in on the whiteboard. Step back... look at it. Move some notes around. Group them. Get a dry-erase marker, and draw some boxes, circles, and arrows. Throw away the redundant notes. Repeat. Call in a co-worker. Repeat. Call in your boss. Repeat... as necessary. Now, take a picture of the whiteboard. Get a notepad, and summarize what you've found. Oh... and all those software tools and processes you were thinking about for knowledge capture? None of them work as well as a whiteboard and a pad of sticky notes. That's because none of them let you work unconstrained by artificial structure, and none of them let you step back and take in the whole of your work. By the way -- the second best tool for knowledge capture is a cocktail napkin.

  7. FIRST: Capturing the Oral Tradition by Tsu+Dho+Nimh · · Score: 5, Informative

    OHHHH!!! ME!!! I KNOW THIS ONE!!!! Been there, done that, have the shurnken heads and tribal tattos to prove it! Also passed ISO9000 on the first try, with only minor criticism of the process docs I wrote.

    These things become like folk medicine or a mystery cult, with multiple strands of "tradition" passed from Master to Student, with people adding their own ideas into them. You will need to reconcile the varying practices among the practicioners, which can lead to bruised egos and outright rebellion. After you have the real process identified and accepted, then you can decide how to deal with it.

    1. Hire a temporary Technical Writer who had done this sort of thing before if you can. They can act like the outside anthropologist.
    2. Let everyone know that they are going to clean up the documentation mess so that they can handle new hires, vacation replacements and temps without having to handhold them and spend days getting them up to speed (the real value of well-written process docs is as a training aid).
    3. Department by department, identify the shamans: the person everyone goes to for training and problem solving.
      You can expect resistance from some shamans: their knowledge may be a source of power and job security to them. One carrot to dangle is the prospect of time freed to do different things instead of being stuck answering questions and training. A stick is the threat of being fired if it is discovered that thye are not handing over all they know - after all, they could be hit by a bus and you would be no worse off than if they are fired and take their tribal knowledge with them.
    4. Have each of the shamans (or the tech writer, or a secretary) write down the process as they understand it - as they are doing whatever that department does, take notes. In a multi-shaman department, you will have several process documents.
    5. If staff are following unofficial crib sheets and hand-written notes to themselves, collect these and make copies of them.
    6. Someone - preferable the technical writer - takes the transcriptions and other documents and reconciles them. Wherever they are in agreement is a non-issue, provided that it works and doesn't violate regulations.
    7. Anywhere two traditions differ must be reconciled. This may mean consulting the operating manual for a piece of equipment (maybe one tradition is using it wrong) and meeting with the shamans to decide which variant makes more sense, is faster, easier or what.
    8. Write the final document and test it. Have someone follow the new process EXACTLY AS WRITTEN and see what happens. The definition of success is that they can follow the document and complete the process with a satisfactory product ... a completed form, a properly filed case, etc.
    9. PUBLISH ... wherever it makes sense.

    TIPS:

    • Follow the process from incoming "raw materials" through to the exit of "finished product"
    • While you are cleaning up the process, check the forms and related documents ... they might be simplified, or they might be the cause of part of your problems.
    • The usual heirarchy is: Policies, Processes, Procedures. Write the docs as modules so you can change a procedure (say if you go from paper to computer filing) without rewriting the a 300-page mother-of-all documents. Policies point to processes, processes point to procedures.
      Refer to operating instructions, do not incorporate operating instructions (I saw one process where EVERYTHING was in the process instrucitons, including how to change the toner on a cdretain brand of photocopier!)