Cleaning your model
1. Is the model tidy?
Is everything in the model fit for public consumption? Are your ‘workings out’, previous drafts and gash diagrams cluttering up the structure?
Models quickly fill-up with half-finished ideas and diagrams. New users won’t know to ignore these. So have a really good tidy up (take a backup first!) and either delete this stuff, or put it into a place where the new user won’t find it, or where it’s obvious that they shouldn’t look at it.
2. Naming and descriptions
Make sure the package and element names make sense to others, not just to you. Packages with names like “Other Stuff” or “Random thoughts” may not make sense to anyone else.
Either tidy these up (see 1) or rename them with something more useful. And give each package a short description, telling the new user what it contains. Is it just some draft ideas? Or signed-off and fixed forever?
3. Ownership of model elements, packages and diagrams
The creator of each package, element and diagram is identified in the EA ‘Author’ field. Are all of those authors still on the project? Or even in the company? If there is a question about the content, who should people talk to now? It will save time and confusion if the author names are changed to the names of the current subject matter experts, so that new readers know where to go for clarification.
Now the existing content has been cleaned up, it’s time to think about finding our way around.
Other articles in this series: