👨‍💻
Federico Trotta's portfolio
  • My portfolio
    • Articles
    • Product Documentation
      • 4Securitas
      • Project Elevate
    • Internal Documentation
      • Internal documentation for 4Securitas
      • Internal documentation for DeAgostini
    • API Documentation
      • Zendesk API: Oauth Tokens management documentation
      • Beam API: Training a Machine Learning Model on a Serverless GPU
      • CoinGecko API: Getting Crypto Values
        • Documenting Python Code With Sphinx
    • Writing Standards I Implement
      • Grammar
      • Overall Design
Powered by GitBook
On this page
  1. My portfolio
  2. Internal Documentation

Internal documentation for 4Securitas

The internal documentation for 4Securitas

PreviousInternal DocumentationNextInternal documentation for DeAgostini

Last updated 1 year ago

Here's how I worked on the internal documentation for 4Securitas:

  • I created the structure of the documentation, dividing the topics into two: Support Infrastructure and Support Troubleshooting. The Infrastructure section has articles regarding knowledge or procedures. The Troubleshooting section has only articles regarding procedures on how to solve troubles internally.

  • Articles are generally structured as step-by-step procedures, providing code or scripts where needed:

The internal documentation structure I made.
An internal procedure I made.