corrad-software/corrad-bp
9
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
corrad-bp/doc/README.md
Md Afiq Iskandar dfaa2f1309 Update README and Documentation for Corrad ProcessMaker 
- Revised the README to provide a comprehensive overview of the Corrad ProcessMaker platform, including its purpose, key components, and technology stack.
- Added detailed sections on the Process Builder and Form Builder, outlining their functionalities and features.
- Introduced a new documentation structure with dedicated files for user guides, technical appendices, and development guidelines.
- Created documentation for the Process Builder and Form Builder, including user instructions, component descriptions, and integration details.
- Enhanced the overall organization and clarity of the documentation to assist developers and users in navigating the platform effectively.
2025-05-19 10:00:27 +08:00

2.0 KiB
Raw Blame History

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

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.