Network documentation is a form of technical documentation, the goal of which is to maintain computer networks. [1] It contains information about how the network is built, how it should perform, and where to troubleshoot problems. The purpose of network documentation is to keep networks running as smoothly as possible while minimizing downtime when repairs are necessary. [1]
Essential parts of network documentation include: [1]
Network documentations could contain charts, tables, diagrams, and even memory aids that help administrators locate information faster. [3]
Though network documentation can be done by hand, large organizations must use network documentation software, including diagramming tools, inventory management, and circuit and cable traces. Examples include draw.io, Graphical Networks' netTerrain, [4] Microsoft Visio, [5] Docusnap, Gliffy, [6] Opnet's Netmapper, and XIA Configuration. [7]
Dia is free and open source general-purpose diagramming software, developed originally by Alexander Larsson. It uses a controlled single document interface (SDI) similar to GIMP and Inkscape.
The unified modeling language (UML) is a general-purpose visual modeling language that is intended to provide a standard way to visualize the design of a system.
Wake-on-LAN is an Ethernet or Token Ring computer networking standard that allows a computer to be turned on or awakened from sleep mode by a network message.
Documentation is any communicable material that is used to describe, explain or instruct regarding some attributes of an object, system or procedure, such as its parts, assembly, installation, maintenance, and use. As a form of knowledge management and knowledge organization, documentation can be provided on paper, online, or on digital or analog media, such as audio tape or CDs. Examples are user guides, white papers, online help, and quick-reference guides. Paper or hard-copy documentation has become less common. Documentation is often distributed via websites, software products, and other online applications.
Network utilities are software utilities designed to analyze and configure various aspects of computer networks. The majority of them originated on Unix systems, but several later ports to other operating systems exist.
User-mode Linux (UML) is a virtualization system for the Linux operating system based on an architectural port of the Linux kernel to its own system call interface, which enables multiple virtual Linux kernel-based operating systems to run as an application within a normal Linux system. A Linux kernel compiled for the um architecture can then boot as a process under another Linux kernel, entirely in user space, without affecting the host environment's configuration or stability.
Microsoft Visio is a diagramming and vector graphics application and is part of the Microsoft 365 family. The product was first introduced in 1992 by former American software company Visio Corporation, and its latest version is Visio 2021. Microsoft acquired the assets of Visio Corporation in 2000 and thus also inherited the licensing agreements for the Visio application. A lightweight version of Visio is now included with all commercial SKU of Microsoft 365 and is known as Visio in Microsoft 365. It has two other subscription based SKUs. Visio Plan 1 includes the Visio web app whereas Visio Plan 2 provides access to both the web app as well as the Desktop application.
Technical writing is the writing of technical content, particularly relating to industrial and other applied sciences, with an emphasis on occupational contexts. The range of audiences for technical writing varies widely. In some cases, it is directed to people with specialized knowledge, such as experts or technicians. In other situations, technical writers help convey complex scientific or niche subjects to end users who need a basic understanding of a concept rather than a full explanation of a subject. Technical writing is the largest part of technical communication.
A UML tool is a software application that supports some or all of the notation and semantics associated with the Unified Modeling Language (UML), which is the industry standard general-purpose modeling language for software engineering.
Flash Video is a container file format used to deliver digital video content over the Internet using Adobe Flash Player version 6 and newer. Flash Video content may also be embedded within SWF files. There are two different Flash Video file formats: FLV and F4V. The audio and video data within FLV files are encoded in the same way as SWF files. The F4V file format is based on the ISO base media file format, starting with Flash Player 9 update 3. Both formats are supported in Adobe Flash Player and developed by Adobe Systems. FLV was originally developed by Macromedia. In the early 2000s, Flash Video was the de facto standard for web-based streaming video. Users include Hulu, VEVO, Yahoo! Video, metacafe, Reuters.com, and many other news providers.
Unicom System Architect is an enterprise architecture tool that is used by the business and technology departments of corporations and government agencies to model their business operations and the systems, applications, and databases that support them. System Architect is used to build architectures using various frameworks including TOGAF, ArchiMate, DoDAF, MODAF, NAF and standard method notations such as sysML, UML, BPMN, and relational data modeling. System Architect is developed by UNICOM Systems, a division of UNICOM Global, a United States-based company.
In software engineering, structured analysis (SA) and structured design (SD) are methods for analyzing business requirements and developing specifications for converting practices into computer programs, hardware configurations, and related manual procedures.
A rogue DHCP server is a DHCP server on a network which is not under the administrative control of the network staff. It is a network device such as a modem or a router connected to the network by a user who may be either unaware of the consequences of their actions or may be knowingly using it for network attacks such as man in the middle. Some kind of computer viruses or malicious software have been found to set up a rogue DHCP, especially for those classified in the category.
In computer programming, a comment is a programmer-readable explanation or annotation in the source code of a computer program. They are added with the purpose of making the source code easier for humans to understand, and are generally ignored by compilers and interpreters. The syntax of comments in various programming languages varies considerably.
SharePoint is a web-based collaborative platform that integrates natively with Microsoft 365. Launched in 2001, SharePoint is primarily sold as a document management and storage system, although it is also used for sharing information through an intranet, implementing internal applications, and for implementing business processes.
Metadata removal tool or metadata scrubber is a type of privacy software built to protect the privacy of its users by removing potentially privacy-compromising metadata from files before they are shared with others, e.g., by sending them as e-mail attachments or by posting them on the Web.
A number of tools exist to generate computer network diagrams. Broadly, there are four types of tools that help create network maps and diagrams:
ConceptDraw DIAGRAM is proprietary diagramming software used to create business graphics, including: diagrams, flowcharts, Infographics, data visualization for business process models, data presentation and project management documentation. It can also be used for creating professional and technical diagrams, such as: UML diagrams, DFD, ERD, computer networks topology, engineering schemes, floor plans, and other technical graphic formats. The program was developed by CS Odessa in 1999. Since 2008, it has formed a part of ConceptDraw OFFICE. A set of solution add-ons that include collections of task-oriented templates and vector stencils libraries, have been released for ConceptDraw DIAGRAM, relating to certain industry-specific graphical tasks. The software also contains a set of tools for vector graphics drawing, along with a built-in presentation mode.
Creately is a SaaS visual collaboration tool with diagramming and design capabilities designed by Cinergix. Creately has two versions: an online cloud edition and a downloadable offline edition for desktop which is compatible with Windows, Mac and Linux. The application is mostly known for creating flowcharts, organization charts, project charts, UML diagrams, mind maps, and other business visuals.