Appearance

Project Management Best Practices ​

Effective project management is what keeps your research organized, transparent, and easy to follow — not just for you, but for everyone working alongside you.

At Avkalan Labs, we follow a documentation-first and communication-driven approach, where each project grows through clear updates, thoughtful notes, and meaningful commits. The goal is simple: make sure your work tells its story clearly, across every platform you use.

1. Maintain Clear and Consistent GitHub Commits ​

Your GitHub repository serves as the single source of truth for your project. Follow these best practices:

  • Commit daily — even small progress should be committed at the end of the day.

  • Use meaningful commit messages that describe what changed and why.

    • Example: Add FEniCS solver for antenna field distribution

  • Commit files in logical chunks — avoid large, unstructured commits.

  • Push your changes regularly so others can review and sync with your work.

  • Use branches for experiments or new features, and merge only after review.

This practice keeps the codebase versioned, reviewable, and transparent.

2. Share Regular Updates on Slack ​

Slack is the team’s communication backbone. All progress, blockers, and insights should be shared there to keep collaboration flowing.

  • Post daily or bi-daily updates summarizing what you’ve worked on.
  • Include screenshots, result images, or short videos to make updates visual.
  • Tag relevant teammates for feedback or review.
  • Use threads to keep discussions organized.
  • When you encounter issues, follow the three-step process (search → share context → escalate to meeting).

Consistent sharing ensures that no progress goes unnoticed and team members can offer timely feedback.

3. Keep Your Obsidian Logs Updated ​

Obsidian acts as your personal and project-level journal. Keeping it updated helps maintain continuity in your research.

  • Create and fill your daily note at the start and end of each workday.
  • Record what you plan to do, what you did, and what you learned.
  • Maintain a folder for meeting notes — summarize discussions, decisions, and next actions.
  • Link related notes, studies, and references for easy navigation.

A well-maintained Obsidian vault allows you (and others) to revisit any stage of your research and quickly understand the context without backtracking through code or messages.

4. Write Thorough Study Definitions ​

Each study folder (in 2_codes/2_workshop/) must include a README.md file that defines the study completely. This document should be self-explanatory and provide full context:

  • Objective: What problem are you studying and why?
  • Approach: Which solver, boundary conditions, and parameters are used?
  • Results: Screenshots or plots with short explanations.
  • Observations: What do the results indicate?
  • Conclusions: Summary, insights, and next steps.

Anyone opening your study folder should be able to understand it without asking questions — that’s the standard for documentation completeness.

5. Capture Meetings and Decisions ​

Team meetings, reviews, and quick discussions often contain valuable technical or strategic decisions.

  • Log every key meeting in your Obsidian meeting notes folder.
  • Note the date, attendees, discussion summary, and next steps.
  • Tag related studies or GitHub issues for traceability.

This ensures no important instruction or feedback is lost and everyone stays aligned on direction.

6. Maintain Context Across All Platforms ​

Think of your project as a connected ecosystem:

  • GitHub → Code and version control.
  • Slack → Communication and discussion.
  • Obsidian → Research documentation and reflection.

All three should tell the same story — what was done, why, and what’s next. Regularly cross-reference between them to maintain consistency.

Summary ​

Good project management is about clarity, consistency, and continuity. By maintaining daily commits, structured Slack updates, organized Obsidian logs, and complete README documentation, you create a workflow where:

  • Your progress is always traceable.
  • Collaboration remains seamless.
  • Research outcomes are reproducible and professional.

Following these best practices ensures your work aligns with Avkalan Labs’ standards of scientific rigor, transparency, and collaborative excellence.