DocsKit follows the Docs as Code approach, where technical documentation is treated like software code, applying version control, collaboration, and automation principles to improve the quality and efficiency of documentation processes.

This guide provides you with the tools you need to write, edit, and review your documentation topics, and demonstrates the recommended Docs as Code Workflow:

Step 1: Writing your content

Step 2: Submitting your content

Step 3: Reviewing the content

Step 4: Editing your content based on feedback

Step 5: Merging your changes

Step 6: Deploying the final content

Git

• Git installed & configured on your machine
• GitHub account & SSH keys added & access to the repo
• GitHub Desktop (optional, recommended)

Editing

• Text editor: e.g., VisualStudioCode, Sublime Text, MacDown
• Knowledge of Markdown syntax