Installation log (scenario summary)

From BasKetUsabilityWiki

Jump to: navigation, search

Scenario title: Martin is keeping an installation log

Martin and his co-workers are documenting and sharing the procedures to install servers and other applications.

Problem Scenario Future Scenario
For the documentation of installation procedures of servers or similar, Martin and his co-workers keep installation logs while they install (or build etc.) software.

Contained in installation logs are links to HOWTOs and other documentation, command sequences, which configuration options were set, needed specific data, like IP addresses.

When written, Martin exports the basket and uploads a copy to the intranet server. Others can then download it. They can even change it, but should ask Martin first, so he pays attention not to change his own basket.

Complete problem scenario

Martin and his co-workers now use a shared basket with sub-baskets for keeping their installation notes. This way, while someone is still working on a log, the others can already see and annotate his notes.

He now copies HOWTOs directly into the basket where it is shown. He can annotate it in place, e.g. correct commands that are not applicable to his specific situation.

He can go to the original source of the HOWTO with just two clicks. For their special needs, Martin can write new note types as plugins relatively easily.

Complete future scenario

[edit] Claims

Image:pro.png note pad is always available when Martin is working on a server.
Image:pro.png Martin can export to web server to share information.
Image:pro.png Martin can look up how he has done something months ago with just a few mouse clicks, or a keyboard shortcut if he wants.
Image:con.png changes in configuration or installation procedure by others cannot be merged back into the original source.
Image:con.png no possibilty for co-workers to extend or annotate installation log.
Image:con.png informations about important configuration changes would be nice to have, but very inconvenient
Image:con.png annotations to HOWTOs cannot be made in the places they reference (i. e., the HOWTO HTML page)
Image:con.png has to check manually if link doesn't work anymore or contents have changed

[edit] Claims

Image:pro.png note pad is always available when Martin is working on a server.
Image:pro.png Martin can share installation log without any extra effort.
Image:pro.png Martin can look up how he has done something months ago with just a few mouse clicks, or a keyboard shortcut if he wants.
Image:pro.png HTML pages or PDFs can be annotated right in place
Image:pro.png web page can be compared to original source and possibly updated.
Retrieved from "http://basket.openusability.org/wiki/index.php/Installation_log_%28scenario_summary%29"
Personal tools