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 into focused sections to help you quickly find the information you need:

Site Usage & Technical Guides

Essential technical knowledge for working with our documentation site project:

• Dev Environment Setup Guide - Learn how to set up and run the Cloudinary doc site locally for development purposes
• Custom Markdown Syntax - Master our specialized markdown features and widgets
• Adding Documentation Pages - Step-by-step guide for creating new pages
• Release Notes Management - Complete workflow for managing release notes
• Site Troubleshooting - Solutions for common technical issues
• Code Widget Testing Guide - Guide to testing code widgets in the content renderer

Documentation Standards

Quality guidelines and style conventions for consistent content:

• Content Style Guide - Writing standards and best practices
• Content Creation Guidelines - Comprehensive content development procedures

Team Resources & Workflows

Collaboration tools and team-specific information:

• Review and Approval Workflows - Content review and approval processes
• Content Planning and Coordination - Planning and project management
• Team Tools and Resources - Essential tools and access information
• External Collaboration Guidelines - Working with other teams and stakeholders

External Resources

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

Most frequently accessed pages:

• Custom Markdown Syntax - For transformation widgets and styled boxes
• Content Style Guide - For writing standards and terminology
• Site Troubleshooting - For technical issues
• Release Notes Management - For release note procedures

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

Getting Help

Internal Support

• Technical Issues: See Site Troubleshooting or reach out to the development team
• Content Questions: Review Content Style Guide or ask team leads
• Process Clarification: Check Editorial Processes or discuss in team meetings

External Resources

• Company Style Guide: Cloudinary Tech Content Guidelines
• Development Resources: Content renderer repository and technical documentation
• Design Assets: Graphics team and brand guidelines

Contributing to This Documentation

This internal documentation is a living resource that grows and improves with team input:

Making Updates

1. Follow the same standards we use for external documentation
2. Test your changes to ensure accuracy
3. Use our standard review process for content approval
4. Update cross-references when adding new content

Suggesting Improvements

• Identify gaps - What information is missing or unclear?
• Propose enhancements - How can we make processes more efficient?
• Share feedback - What's working well and what needs improvement?

Quick Navigation