In my last company, we had plenty of detailed specifications. Our materials used, our project deliverables, including cad/bim standards, etc.
The only processes and procedures we had (outside of preventative maintenance checklists on our equipment) were the ones we had to make for the disaster recovery plans (aka, we lose some part of our system, here's how we'd maintain and replace X function for 1 day, 2 day, a week, etc).
As I was wrapping up my employment there, I started writing processes and procedures for my role(s). I say plural, because a lot of my duties were shuffled off onto other people, because they really had nothing to do with the job I was hired to do and wouldn't be foisted on my replacement.As I was writing those, I tended to organize it like the No Experience Required book that I edit. Like...
Overview of the topic / Goal of process - what
Explanation of why we're taking action a certain way - why
Step by Step procedure - who/where/how
*any applicable caveats/warnings, etc
Since it was such a massive brain dump, trying not to lose the benefit of all of my work and avoiding overwhelming the person(s) who would come along later so they didn't waste time floundering (or, more likely, get frustrated and overwhelmed and leave), I decided that in my new role, I would document as I went along. My first three months here were really slow, as I waited for a system upgrade to take place, I took all of the notes my consultant had given me when interviewing each of my users, and started clarifying them.
Obviously, one huge benefit to me as well, was ensuring that I understood everything, by writing an explanation myself.
As the old aphorism goes, 'if you can't explain it simply, you don't understand it well enough.'
A few months ago, my company started an initiative to formalize processes and procedures for the support departments (our money-making areas already had these well established). I took my processes and fit them into my boss's template and boom, 15 pages of documentation, containing what/why/who/where/how. He did comment to me recently, as I'm taking on some more tasks from our corporate facilities manager, who has been too busy to do more than the basics on those p&p docs, that he viewed the manual as more of a workflow guide, and not necessarily something that would provide us with step by step instructions.
I kind of boggled at that, of course. I don't think it does much good to say 'import employees and update space records and run occupancy report', when you're not even saying what employee data you need, where it comes from, who it goes to, how it gets into the system and how and why we run each of our reports.
Not sure I've really got a point here. I'm not going to change the 'no experience required' way that I'm documenting and/or editing these processes, but, I would like to hear from others.
1. Do you have processes and procedures for your company/department?
2. If so, does it contain an overall workflow?
3. Explanations of why things are set up the way they are?
4. Step by step instructions which could actually serve as training if need be?
Would really love to hear any other comments you've got about processes and procedures. Graphics heavy? Flow charts to make things simple? All text? Or text interspersed with graphics?