​

FlowX.AI Documentation Rules

​

Project Overview

​

Technical Writing Standards

​

FlowX-Specific Terminology

• FlowX.AI - The complete platform name (not FlowX or Flowx)
• FlowX Designer - The visual process design tool
• FlowX Engine - The core process execution engine
• Process Definition - Template for creating process instances
• Process Instance - Running instance of a process definition
• Node - Individual components in a process flow (not “step” or “task”)
• Action - Operations performed by nodes
• Token - Process execution pointer moving through the flow
• Swimlane - Process lanes for role-based task assignment
• Business Rule Action - DMN-based decision logic
• Integration Designer - Tool for building external system connections
• Task Management Plugin - Extension for task allocation and management
• Notification Plugin - Extension for sending notifications
• Document Plugin - Extension for document generation and management

​

Content Structure Requirements

​

File Organization

• All version-specific content goes in versioned directories (e.g., 5.0-tech-preview/)
• Use kebab-case for file and directory names
• Group related content in logical subdirectories
• Keep file paths concise but descriptive

​

Required Frontmatter

---
title: "Clear, descriptive title following FlowX naming conventions"
description: "Concise description explaining the page's purpose and value"
---

​

Content Flow Standards

• Start with overview/introduction
• Follow with prerequisites when applicable
• Use progressive disclosure (basic → advanced concepts)
• Include practical examples and use cases
• End with next steps or related topics

​

FlowX Platform Context

​

Core Components to Reference

• FlowX Engine: Process execution, token management, data handling
• FlowX Designer: Visual process modeling, UI design, testing
• Core Extensions: Task Management, Content Management, Integration Management
• Plugins: Notifications, Documents, Reporting, OCR, Customer Management

​

Common Integration Points

• Kafka: Message streaming and event-driven architecture
• Elasticsearch: Search and indexing capabilities
• Redis: Caching and session management
• PostgreSQL: Primary database for process data
• Kubernetes: Container orchestration and deployment
• NGINX: Load balancing and reverse proxy

​

Business Process Standards

• BPMN 2.0: Business Process Model and Notation
• DMN: Decision Model and Notation for business rules
• MVEL: Expression language for dynamic content

​

Code and Configuration Standards

​

Code Examples

• Always provide complete, runnable examples
• Use realistic data instead of placeholder values
• Include proper error handling
• Test all code examples before publishing
• Specify language and include filename when relevant

​

Configuration Examples

• Show both development and production configurations
• Include security considerations
• Provide environment-specific variations
• Document all configuration parameters

​

API Documentation

• Document all endpoints with complete request/response examples
• Include authentication requirements
• Show error responses with proper HTTP status codes
• Provide rate limiting information
• Include SDK examples when available

​

Mintlify Component Usage

​

When to Use Each Component

​

Process Documentation

• Steps: Use for setup procedures, configuration guides, process flows
• Tabs: Use for different deployment environments (dev/prod) or platform variants
• Accordions: Use for troubleshooting sections or optional configurations

​

Technical Reference

• ParamField: For API parameters, configuration options
• ResponseField: For API responses, data structures
• CodeGroup: For multi-language examples (Java, JavaScript, Python, etc.)

​

User Guidance

• Note: For additional context or helpful information
• Tip: For best practices and optimization advice
• Warning: For breaking changes, security considerations, or destructive actions
• Info: For neutral announcements or background information

​

Navigation and Discovery

• Cards: For feature overviews, getting started guides
• CardGroup: For related topics or component categories

​

FlowX-Specific Component Patterns

​

Process Flow Documentation

<Steps>
<Step title="Create Process Definition">
    Navigate to FlowX Designer and create a new process definition.
    
    <Note>
    Process definitions serve as templates for creating process instances.
    </Note>
</Step>

<Step title="Add Nodes">
    Add nodes to define your process flow.
    
    <Tabs>
    <Tab title="Start Node">
        Every process must begin with a start node.
    </Tab>
    <Tab title="Task Node">
        Use task nodes for automated operations.
    </Tab>
    <Tab title="User Task Node">
        Use user task nodes for human interactions.
    </Tab>
    </Tabs>
</Step>
</Steps>

​

Configuration Documentation

<ParamField path="process.name" type="string" required>
Unique identifier for the process definition within the application.
</ParamField>

<ParamField path="process.swimlanes" type="array">
List of swimlane configurations for role-based task assignment.

<Expandable title="Swimlane Properties">
    <ParamField path="swimlanes[].name" type="string" required>
    Name of the swimlane for identification.
    </ParamField>
    
    <ParamField path="swimlanes[].expression" type="string">
    MVEL expression for dynamic swimlane assignment.
    </ParamField>
</Expandable>
</ParamField>

​

Development Workflow

​

File Management

• Use descriptive filenames that match content topics
• Maintain consistent directory structure across versions
• Keep related files grouped in logical subdirectories
• Use version-specific directories for major releases

​

Content Updates

• Update navigation in docs.json when adding new pages
• Maintain backward compatibility when updating existing content
• Use proper redirects for moved or renamed content
• Test all internal links after content changes

​

Quality Assurance

• Verify all code examples are syntactically correct
• Test all external links for availability
• Validate Mintlify component syntax
• Ensure proper heading hierarchy (H2 → H3 → H4)
• Check for consistent terminology usage

​

Version Management

• Keep version-specific content in separate directories
• Maintain feature parity documentation across versions
• Document breaking changes and migration paths
• Use clear versioning in titles and descriptions

​

Content Guidelines

​

Writing Style

• Use second person (“you”) for instructions
• Write in active voice
• Use present tense for current states
• Use future tense for outcomes and results
• Keep sentences concise and clear

​

Technical Accuracy

• Validate all technical information through testing
• Include version-specific information when relevant
• Document prerequisites and dependencies
• Provide troubleshooting for common issues

​

User Experience

• Focus on user goals and outcomes
• Anticipate common questions and pain points
• Provide multiple learning paths when appropriate
• Include visual aids and diagrams when helpful

​

Error Prevention

​

Common Pitfalls to Avoid

• Don’t use placeholder data in examples
• Don’t skip error handling in code examples
• Don’t assume prior knowledge without providing context
• Don’t use inconsistent terminology
• Don’t create orphaned pages without proper navigation

​

Validation Checklist

• All code examples tested and working
• All links functional and pointing to correct resources
• Proper Mintlify component syntax used
• Consistent terminology throughout
• Clear heading hierarchy maintained
• Prerequisites and context provided
• Expected outcomes documented
• Troubleshooting included for complex procedures

​

AI Assistant Integration

​

FlowX AI Features

• AI Designer: Automated process design assistance
• AI Developer: Code generation and optimization
• AI Analyst: Process analytics and insights
• AI Architect: System design recommendations
• AI Assistant: General-purpose help and guidance

​

AI-Driven Development

• Document AI-assisted workflows and capabilities
• Provide examples of AI-generated content
• Explain AI decision-making processes
• Include best practices for AI feature usage