Engineering

Quick Start Guides

Practical, actionable guides for daily development work.

Engineering Cheat Sheet

One-page reference with core beliefs, non-negotiables, and naming conventions.

  <a href="development-workflow/" class="doc-card">
    <h4 class="card-title">Development Workflow</h4>
    <p class="card-description">
      Complete workflow from idea to production. Design, build, test, review, deploy, and monitor.
    </p>
    <div class="card-meta">
      <span class="card-meta-item">8 steps</span>
      <span class="card-meta-item">15 min read</span>
    </div>
  </a>

  <a href="git-workflow/" class="doc-card">
    <h4 class="card-title">Git Workflow - using React</h4>
    <p class="card-description">
      Branching strategy, commit conventions, and PR process for React development with our template.
    </p>
    <div class="card-meta">
      <span class="card-meta-item">10 steps</span>
      <span class="card-meta-item">20 min read</span>
    </div>
  </a>

  <a href="pr-guidelines/" class="doc-card">
    <h4 class="card-title">PR Template &amp; Guidelines</h4>
    <p class="card-description">
      What to include in every pull request. Checklist for authors and guidelines for reviewers.
    </p>
    <div class="card-meta">
      <span class="card-meta-item">Template</span>
      <span class="card-meta-item">5 min read</span>
    </div>
  </a>

  <a href="onboarding/" class="doc-card">
    <h4 class="card-title">Onboarding Checklist</h4>
    <p class="card-description">
      A 90-day roadmap for new engineers. Week-by-week tasks from setup to ownership.
    </p>
    <div class="card-meta">
      <span class="card-meta-item">90 days</span>
      <span class="card-meta-item">10 min read</span>
    </div>
  </a>

  <a href="playbook-in-practice/" class="doc-card">
    <h4 class="card-title">Playbook in Practice</h4>
    <p class="card-description">
      Real stories from Orcta engineering. Learn from what went well and what did not.
    </p>
    <div class="card-meta">
      <span class="card-meta-item">6 stories</span>
      <span class="card-meta-item">15 min read</span>
    </div>
  </a>
</div>

Complete Documentation

In-depth resources covering all aspects of engineering at Orcta.

Engineering Philosophy

Our core beliefs about how we build software. Principles over tools, progressive abstraction, and craftsmanship.

Guide 10 min read

  <a href="engineering-playbook/" class="doc-card">
    <h4 class="card-title">Engineering Playbook</h4>
    <p class="card-description">
      Practices, rituals, and processes. From code standards to incident response.
    </p>
    <div class="card-meta">
      <span class="card-meta-item">Guide</span>
      <span class="card-meta-item">30 min read</span>
    </div>
  </a>

  <a href="naming-conventions/" class="doc-card">
    <h4 class="card-title">Naming Conventions</h4>
    <p class="card-description">
      Style guide for JavaScript, TypeScript, Python, and Go. File naming and best practices.
    </p>
    <div class="card-meta">
      <span class="card-meta-item">Reference</span>
      <span class="card-meta-item">10 min read</span>
    </div>
  </a>
</div>

Why These Docs Exist

Documentation as a force multiplier for engineering teams.

Faster Onboarding

New engineers ship their first PR in days, not weeks. Clear guides eliminate guesswork.

Consistent Standards

Everyone follows the same patterns. Code reviews are faster. Codebases are more maintainable.

Shared Understanding

Documentation captures tribal knowledge. What one person learns, everyone can benefit from.

Additional Resources

Internal Links

  <div class="quick-links">
    <h4 class="quick-links-title">Tools &amp; Automation</h4>
    <ul class="link-list">
      <li class="link-item">
        <a href="pre-commit-setup/">
          <span>Pre-commit Hooks Setup</span>
          <span class="link-arrow">→</span>
        </a>
      </li>
      <li class="link-item">
        <a href="/">
          <span>CI/CD Pipeline Docs</span>
          <span class="link-arrow">→</span>
        </a>
      </li>
      <li class="link-item">
        <a href="/">
          <span>Monitoring &amp; Alerts Setup</span>
          <span class="link-arrow">→</span>
        </a>
      </li>
    </ul>
  </div>

  <div class="quick-links">
    <h4 class="quick-links-title">Need Help?</h4>
    <ul class="link-list">
      <li class="link-item">
        <a href="https://chat.google.com/app/home">
          <span>Ask in #all-engineers</span>
          <span class="link-arrow">→</span>
        </a>
      </li>
      <li class="link-item">
        <a href="/">
          <span>Schedule Office Hours</span>
          <span class="link-arrow">→</span>
        </a>
      </li>
      <li class="link-item">
        <a href="/">
          <span>Submit Feedback</span>
          <span class="link-arrow">→</span>
        </a>
      </li>
      <li class="link-item">
        <a href="/">
          <span>Propose Doc Changes</span>
          <span class="link-arrow">→</span>
        </a>
      </li>
    </ul>
  </div>
</div>