Lähiverkon dokumentointi

Abstract

Tässä opinnäytetyössä tarkasteltiin laadukkaan lähiverkkodokumentaation suunnittelun ja toteutuksen käytäntöjä, sekä tiedon ylläpidon ongelmakohtia niin teknisesti, kuin myös organisaatioiden välisten vastuiden kannalta.

Dokumentaation suunnittelun ensimmäisiä vaiheita ovat tiedon hallinnan ja jakamisen menetelmät, sekä komponenttien nimeämiskäytäntöjen ja tunnushierarkioiden luominen. Ne muodostavat pohjan, jolle varsinaista dokumentaatiota aletaan rakentaa.

Perusedellytysten valmistelun jälkeen voidaan jatkaa dokumentaation suunnittelua sopivien työkalujen, topologioiden ja esitystapojen valinnalla. Erityyppiset ohjelmistot rajoittavat tai tukevat dokumentaation osa-alueita eri tavoin. Sen vuoksi niiden ominaispiirteisiin tiedon esittämisessä liittyi lukuisia näkökohtia, joita dokumentoinnissa tulisi huomioida.

Hyvä dokumentaatio kattaa verkon osakokonaisuudet toteutettuna juuri sillä tarkkuudella, kuin on tarkoituksenmukaista. Siksi opinnäytetyössä pyrittiin antamaan työkaluja sopivan dokumentointitason löytämiseksi erilaisille organisaatiolle ja verkkoympäristöille, huomioiden kuitenkin kokonaisuuden hallintaan liittyvät haasteet, jotka pysyvät samoina ympäristöstä riippumatta.

Ylläpitäjän kannalta katsottuna hyvin dokumentoidun verkon hallinta on helpompaa ja työ vähemmän kuormittavaa, kun tiedetään, miten verkko on rakennettu ja minkälaista dataa siellä liikkuu.

This thesis examined the best practices of designing and implementing a high quality local area network documentation. The project included updating and administrating documented information from a technical point of view but also from an inter-organizational liabilities perspective.

The first phases in documentation design are to consider the methods of information management and sharing. In addition, the design of object naming and ID hierarchies are crucial parts in the base where documentation is built on.

After these basic conditions have been planned, the documentation design process can continue by selecting proper software, and the best suitable document topology and layout. Different software solutions support or limit various parts of documentation in several different ways. Therefore, their versatile features and default methods to present information should be carefully considered, when documentation is designed.

Good documentation covers every part of the network implemented with accuracy that is appropriate for that network. The aim of this thesis project was to provide the tools and ideas to find the correct depth of documentation for different organizations and network environments. It also considered the challenge of information management at an overall level, because this remains the same in any kind of environment and organization.

From an administrator’s perspective, administrating a well-documented network is straightforward work, and causes less of a mental and physical load, when the administrator knows how a network is built, and what kind of data traffic is moving in there.