Technical Documentation

[pdenableetoavit19698]

Hi there,

I am looking at finding what is the best "simple" way to structure work and especially work/changes brought across a network. A simple way to provide:

1) plan structure project/tasks to be completed

2) reporting documentation of reverse engineering/problems/solutions advised or applied

3) technical documentation of network/topology/switches/routers/vlans/firewall configurations for technical records and support

Be it building a new system, but even better when bringing changes in to an existent system when a lot of reverse engineer was needed as system underwent a lot of changes in the last 5 years but nobody documented anything.

Would be great of you could recommend template/links/ideas

- Situation analysis of problems/risks > solutions offered, potentially in multiple steps

- Reverse engineering approach/findings/methods/troubleshooting/analysis/corrective actions-solutions

- Documenting per subgroups (WAN/LAN/WLAN/DEVICES/CLIENTS/LOGIC) the work/tasks completed

Thank you so much for any suggestions! 

[Flavio Miranda]

Hi

 All this was thought and put in writing and we have certification for all that. All you are looking for is inside the ITIL documentation.

Seach for ITIL 4 Framework

[kiaan22]

Hey Everyone, I hope all of you will be fine!

One simple way to structure work and changes across a network is to use a version control system VCS such as Git. Git allows you to track changes to files and collaborate with others on the same project. It allows you to create branches to work on specific features or fixes, and merge them back into the main codebase once they are complete. Additionally, Git allows you to revert changes and keep a history of all changes made to the code. Another option is to use a project management tool such as trello or asana to organize tasks and track progress. These tools allow you to assign tasks, set due dates, and communicate with team members to ensure everyone is on the same page.