IT Documentation

Wednesday, 07 May 2025

ⓕ 𝕏 in

Overview

IT Department Document and Knowledge Repository Website

Role/Responsibilities

Assigned to find tools for collecting IT-related documents and knowledge. This aims to gather and record information and expertise from the work experiences of each IT team member, serving as a central repository of critical IT knowledge for the organization.

Problems/Challenges

Historically, the organization has lacked a structured plan for capturing knowledge from IT work experiences. This, combined with staff resignations and retirements, has resulted in inconsistent onboarding processes. Existing information is often outdated, leading to frequent redevelopment of systems. Recognizing these issues presents an opportunity to establish an IT document and knowledge repository website to streamline operations, provide a central knowledge source for the IT team and the organization, and resolve the identified problems.

Design Concept

Research was conducted on programming languages and tools suitable for this purpose. Emphasis was placed on ease of use and standardization. Consequently, VitePress was selected due to its ability to leverage Vue.js for further development and its support for Markdown content, which offers versatility and a straightforward writing method.

Technologies/Tools

Frontend: Vue.js (VitePress) used to design a static content website with Markdown.
DevOps: Docker used for deploying the API component, and Kong API Gateway is used for reverse proxying the Frontend.

Features

Content creation using Markdown format.
Support for multiple languages.
Accurate and fast search functionality.
Light/Dark theme selection.

Outcome

Following the selection of tools and the development of the IT department's comprehensive document and information website (including system development information, server details, etc.), key topics were organized into intuitive and systematic menus. Its implementation has facilitated easy and complete access to information, marking the beginning of a systematic and efficient data management approach for the organization.