- Revised the README to reflect the latest updates, including the last modified date. - Updated the USER_GUIDE to include detailed sections on node configurations, specifically for Business Rules, API Tasks, and Form Tasks. - Enhanced the documentation structure with consistent design patterns for UI elements, step indicators, and variable management. - Added best practices for creating and testing business rules, along with example use cases to assist users in implementing conditional logic. - Improved overall clarity and organization of the documentation to facilitate better understanding and usability for developers and users.
Corrad ProcessMaker Documentation
Welcome to the Corrad ProcessMaker documentation. This repository contains comprehensive guides and technical documentation for developers and users of the Corrad ProcessMaker platform.
Documentation Structure
The documentation is organized into the following sections:
Overview
- Project Overview - Introduction to the system and its capabilities
- Architecture - Technical architecture of the system
- Development Guide - Guide for new developers
Process Builder
- User Guide - How to use the Process Builder
- Technical Guide - Technical details of the Process Builder implementation
- Roadmap - Planned improvements for the Process Builder
Form Builder
- User Guide - How to use the Form Builder
- Technical Guide - Technical details of the Form Builder implementation
Getting Started
New to the project? We recommend reading the documentation in this order:
- Project Overview - Understand what the system does
- Development Guide - Learn how to set up your development environment
- Architecture - Understand the technical architecture
- User guides for components you'll be working with
- Technical guides for deeper implementation details
Contributing to Documentation
When contributing to this documentation:
- Keep the structure organized and logical
- Update cross-references when moving or renaming files
- Ensure code examples are up-to-date
- Include diagrams where helpful
- Keep the language clear and concise
Contact
If you have questions about this documentation or need help with the system, please contact the development team.
Last updated: July 10, 2024