That’s a posting I wanted to do for quite some time, because that’s what I do for a living.
Large IT-projects need to be documented very precisely. It all starts with a project-plan, eventually leading to a detailed network diagram. In this series of postings I’ll describe how I plan and implement large new IT-installations.
Documentation is essentially for a couple of reasons:
- You need planning to really know what you actually want to achieve with your installation
- You need the documentation to have a test-handbook so that the customer knows that the sold solution matches their requirements
- You need all of it for further references, if you run into technical problem later.
What this series of postings will cover:
No series of posting without a thorough plan.
- I’ll show how to define the areas of responsibilities within the scope of an IT-project
- I’ll show how to create documents for certain audiences: Manager need other documents than the IT-crowd; yet the security-people need other documents than the techs.
- I’ll present a framework of documents which is used in my company
The framework I’m about to present will be useful for IT-manager, people who plan IT-projects, security-people and the maintenance-staff.
In the next couple of weeks I’ll release postings covering the following subjects:
- Getting it all together: Defining the scope of the project (Posting #2)
- Defining Engineering-related requirements: Bill of materials, electrical requirements and room-plans (Posting #3)
- Defining IT-related requirements: Interfaces, network-segments, IP-networks (Posting #4)
- IP- and security planning: Detailed documentation of servers and firewall rules (Posting #5)
- Engineering: Creating a detailed hardware-setup (Posting #6)
- Acceptance tests – how you prove that the system works a planned (Posting #7)
This series of postings will start with the first posting, defining the scope of the project.
I’d be happy to get your feedback.