corrad-bp/doc/README.md
Md Afiq Iskandar 0a4d41df06 Enhance Documentation and Navigation for Process Execution Module
- Added new sections in the README and PROJECT_OVERVIEW to include user and technical guides for the Process Execution interface.
- Updated navigation structure to incorporate the Process Execution module, detailing features such as the Execution Dashboard, Task Inbox, and Case History.
- Improved overall documentation clarity and organization to assist users in understanding the new process execution functionalities.
2025-05-21 13:36:43 +08:00

2.2 KiB

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

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

Process Execution

  • User Guide - How to use the Process Execution interface
  • Technical Guide - Technical details of the Process Execution implementation

Getting Started

New to the project? We recommend reading the documentation in this order:

  1. Project Overview - Understand what the system does
  2. Development Guide - Learn how to set up your development environment
  3. Architecture - Understand the technical architecture
  4. User guides for components you'll be working with
  5. Technical guides for deeper implementation details

Contributing to Documentation

When contributing to this documentation:

  1. Keep the structure organized and logical
  2. Update cross-references when moving or renaming files
  3. Ensure code examples are up-to-date
  4. Include diagrams where helpful
  5. 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