Md Afiq Iskandar
0a4d41df06
- 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.
51 lines
2.2 KiB
Markdown
51 lines
2.2 KiB
Markdown
# 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](./overview/PROJECT_OVERVIEW.md) - Introduction to the system and its capabilities
|
|
- [Architecture](./overview/ARCHITECTURE.md) - Technical architecture of the system
|
|
- [Development Guide](./overview/DEVELOPMENT_GUIDE.md) - Guide for new developers
|
|
|
|
### Process Builder
|
|
- [User Guide](./process-builder/USER_GUIDE.md) - How to use the Process Builder
|
|
- [Technical Guide](./process-builder/TECHNICAL_GUIDE.md) - Technical details of the Process Builder implementation
|
|
- [Roadmap](./process-builder/ROADMAP.md) - Planned improvements for the Process Builder
|
|
|
|
### Form Builder
|
|
- [User Guide](./form-builder/USER_GUIDE.md) - How to use the Form Builder
|
|
- [Technical Guide](./form-builder/TECHNICAL_GUIDE.md) - Technical details of the Form Builder implementation
|
|
|
|
### Process Execution
|
|
- [User Guide](./process-execution/USER_GUIDE.md) - How to use the Process Execution interface
|
|
- [Technical Guide](./process-execution/TECHNICAL_GUIDE.md) - Technical details of the Process Execution implementation
|
|
|
|
## Getting Started
|
|
|
|
New to the project? We recommend reading the documentation in this order:
|
|
|
|
1. [Project Overview](./overview/PROJECT_OVERVIEW.md) - Understand what the system does
|
|
2. [Development Guide](./overview/DEVELOPMENT_GUIDE.md) - Learn how to set up your development environment
|
|
3. [Architecture](./overview/ARCHITECTURE.md) - 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 |