| Requirement Pattern Online Help | Description | This pattern expresses the need of offering online help to system users. | |
| Comments | The language is assumed to be the same than the user interface language | ||
| Pattern goal | Learn more about system functionality whilst being operated by the user | ||
| Author | GESSI-SSI | ||
| Sources (0..*) |
| ||
| Keywords (0..*) | F1, Help, Help format | ||
| Dependencies (0..*) | IMPLIES Interface Language IMPLIES Authorization | ||
| Requirement Form Online Help | Description | This form expresses the general concept of online help and several extensions for the scope, user profile-dependency and technology | |
| Comments | Application of extensions: Local Online Help, Full Online Help, Profile-dependant Online Help, Online Help Technology: may be applied at most once each. Local Online Help and Full Online Help are mutually exclusive | ||
| Version date | 2009-03-20 00:00:00.0 | ||
| Author | GESSI-SSI | ||
| Sources (0..*) |
| ||
| Fixed Part | Question text | ---- | Form text | The system shall provide online help |
| Extended Part Full Online Help | Question text | ---- | Form text | Online help shall be available on every screen displayed by the system |
| Extended Part Local Online Help | Question text | ---- | Form text | Online help shall be available at least for the %systPartNames% system parts |
| Parameter | Metric | ||
| systPartNames: is a non-empty set of system part names (a part may be a module, a subsystem, a functionality, etc.) | SystemPartNames: SystemPartNames = Set(String) SystemPartName = String | ||
| Extended Part Online Help Technology | Question text | ---- | Form text | Online help shall be based on the %helpTechnologies% online help technologies |
| Parameter | Metric | ||
| helpTechnologies: is a non-empty set of online help software technologies | OnlineHelpTechnologies: OnlineHelpTechnologies = Set(OnlineHelpTechnology) OnlineHelpTechnology = Domain(DotNetHelp, JavaHelp, \n WinHelp, AP Help, MS HTML Help, \n WebHelp, HTML, …)\n | ||
| Extended Part Profile-dependant Online Help | Question text | ---- | Form text | Online help shall be available at least for the %userProfiles% user profiles |
| Parameter | Metric | ||
| userProfiles: is a non-empty set of user profiles | UserProfiles: UserProfiles = Set(UserProfile) UserProfile = Domain(Administrator, Author, User, ...) | ||