Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added content for "What are Development Best Practices" #252

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

added content for "What are Development Best Practices" #252

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 37 additions & 1 deletion content/docs/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,43 @@ A design pattern is a repeatable template of how to solve a common development c

### What are Development Best Practices?

(more text coming soon)
They are a set of standardized, proven techniques and methodologies designed to enhance the efficiency, quality, maintainability, and scalability of AL development projects. Below are key categories and examples of these best practices:

#### 1. Planning
- **Define Clear Requirements**: Collaborate with Business Central functional consultants and stakeholders to document requirements in a detailed and unambiguous manner.
- **Create a Roadmap**: Establish timelines and milestones for development.

#### 2. Designing
- **Adopt Design Patterns**: Use AL design patterns where applicable.
- **Plan for Scalability**: Design systems to handle increased load with minimal changes.
- **Focus on Modularity**: Break down the application into smaller, manageable, and reusable components.

#### 3. Development
- **Write Clean Code**: Follow coding standards like consistent naming conventions and proper indentation.
- **Version Control**: Use tools like Git for source code management and collaboration.
- **Iterative Development**: Use methodologies like Agile or Scrum for incremental progress.

#### 4. Testing
- **Unit Testing**: Validate individual units or components for correctness.
- **Integration Testing**: Ensure that components work together as expected.
- **Continuous Testing**: Use automated testing frameworks to catch bugs early and often.
- **Test-Driven Development (TDD)**: Write tests before coding to guide development.

#### 5. Communication
- **Regular Standups**: Use daily standups to ensure alignment and address blockers.
- **Code Reviews**: Peer reviews help identify potential issues and share knowledge.
- **Documentation**: Maintain clear and concise documentation for code, APIs, and user guides.
- **Tooling**: Use platforms like Auzre DevOps or JIRA for effective communication and task tracking.

#### 6. Deployment
- **CI/CD Pipelines**: Implement Continuous Integration and Continuous Deployment to streamline delivery.
- **Environment Parity**: Ensure development, staging, and production environments are consistent.
- **Rollback Strategies**: Plan for quick rollbacks in case of deployment failures.

#### 7. Post-Deployment
- **Gather User Feedback**: Incorporate user feedback for iterative improvements.
- **Maintenance and Updates**: Regularly update software to fix bugs, address security issues, and improve features.


### History of "NAV Design Patterns"

Expand Down