Keeping Server System Log
task description
Bit of abstraction: server, site of our work is at the same time the object of it.
Command line interface (cli) is
working environment, where we spend vast
majority of our time, where we execute all actions that operate on object of our work.
Object of our work is is a collection of components (hardware,OS,applications) and
level of complexity of interpendencies between them is difficult to predict, to put
it mildly, impossible, to be true to personal experience and history of the object.
solution description
Document components, what are they, how are they configured, what are the
interdependecies that we know of, and all the changes that we make to any part of it.
features that would make a good solution
storing documenation
Interlinked documentation helps a lot to navigate it and to track dependencies between
components, which in turn helps in server maintainance and development. Ability to
have multiple documents, edit, have complete history of all edits, see differences
between version, see who and when edited what, refactor by splitting/merging/recombining
documents, add metadata to documents, export documets in different formats, create
larger documention out of smaller ones.
creating and using documentation
Command line is not just the exclussive interface to the server, it's a whole
environment. Ability to create documents directly into their own storage system
and to add to exising ones, all without leaving our working environment, is
essential. So is the ability to automaticaly see most important changes on
entering the environment.
to top