Internal Documentation Overview

Welcome to Internal Documentation

This internal documentation hub provides comprehensive guides, standards, and resources for our documentation team. Whether you're new to the team or looking for specific procedures, you'll find everything you need to create, maintain, and improve our documentation.

What You'll Find Here

Our internal documentation is organized by the typical workflow journey:

Getting Started

One-time setup for new team members

• Dev Environment Setup Guide - Set up Docker, clone the repo, run the site locally
• Essential Tools - IDE, extensions, Git, Vale linter

Writing Content

Daily reference for authoring

• Custom Markdown Syntax - Transformation widgets, styled boxes, partials, video players
• Content Style Guide - The 10 commandments, UI docs, Console terminology
• Adding Documentation Pages - File creation, menus, SEO, front matter
• Content Creation Guidelines - SDKs, add-ons, video tutorials, code explorers

Review & Publish

Getting content live

• Review and Approval Workflows - JIRA reviews, GitHub PRs, assignees
• PR Previews - Automatic preview deployments for PRs
• Release Notes Management - RN workflow, archives, RSS feeds

Operations

Technical maintenance and tools

• Site Troubleshooting - Docker issues, CI failures, debugging
• Automated Processes - Cursor rules, commands, scripts
• Code Widget Testing - Content renderer validation

Team & Planning

Admin, coordination, analytics

• Content Planning and Coordination - Sprint planning, JIRA management
• External Collaboration Guidelines - Marketing, Subject Matter Experts, deployment freezes
• Advanced Tools - A/B testing, deployment, QlikSense
• FIN Analysis Process - Conversation analysis rota

External Resources

• Cloudinary Docs Style Guide: Cloudinary Tech Content Guidelines
• UI Strings: Cloudinary Microcopy (UI String) Style Guide
• UI Strings GPT: UI String Assistant

Documentation Philosophy

Our documentation follows these core principles:

User-Centered Approach

• Know your audience - Consider the reader's technical level and goals
• Provide practical value - Include actionable examples and clear instructions
• Test everything - Ensure all code examples and procedures work

Quality and Consistency

• Maintain high standards - Follow established style guides and best practices
• Keep content current - Regularly update information to reflect latest features
• Cross-reference effectively - Link related content to improve discoverability

Collaboration and Efficiency

• Document processes - Make workflows transparent and repeatable
• Share knowledge - Ensure information is accessible to the entire team
• Continuously improve - Regularly review and enhance our documentation