|
|
| Re: Use Outside of Software Development [message #901886 is a reply to message #885492] |
Tue, 14 August 2012 17:34  |
Eclipse User |
|
|
|
Hi Bryan:
You weren't very specific about what you are documenting, so please take this as encouragement. I am currently using EPF to document the operation of a very complex credit application system for a bank. The key was to start from scratch. The following structure is what we are using, and it seems to be working fairly well:
base.common - contains common information, such as the glossary, the copyright page, and welcome information. It also contains how-to and business background information. Most of the content here is setup as guidelines - including concepts and term definitions. I have packages defined within to allow for grouping of these items.
base.
base.forms - contains information about the various forms that are produced. The forms are prepared as Work Products. I use Guidelines (checklists) to provide additional information.
base.navigation - contains custom categories used to setup the views on the menu of the resulting website.
base.processes - contains the information about the tasks and processes that are done through the system
base.products - contains the information about the products that are processed through the system - such as the various types of loans.
base.roles - contains the information about the various roles - both people and systems - that are involved in the processes.
base.screens - contains the information about the various screens that are used - including sample screenshots. The screens are prepared as work products. If there is additional information required, then these are prepared as guidelines - primarly checklists.
base.security - contains the information about the different types of security that can be attached to products.
I warn you that it is tedious, and does require some trial and error, but the effort is worth it. Set up categories within each group that make sense and associate them with the items. For example, we have forms that print through an application called OCP while other forms are prepared by a specific department. So I have two categories - OCP Form and non-OCP Form that I attach to the form item.
I would offer to share, but it is bank proprietary, so I'm afraid that I can't. Hopefully, this gives you some idea of how to approach the problem.
Regards,
|
|
|
Powered by
FUDForum. Page generated in 0.03382 seconds
Home
