# Engineering

## **1. Debug Errors and On-Call Issues**

Quickly troubleshoot failing tests, development errors, and configuration issues.

**Examples:**

* "What does this error message \[error message] mean in the context of \[project name]?"
* "How do I resolve a failed deployment for \[environment name]?"
* "What are the steps to debug a memory leak in \[specific framework]?"
* "What does the log entry \[log snippet] indicate?"

***

## **2. Review and Optimize Code**

Get instant feedback on code quality and learn best practices to improve code performance.

**Examples:**

* "Can you review this code snippet for potential issues?"
* "What are the best practices for writing secure code in \[programming language]?"
* "How can I optimize this SQL query for better performance?"
* "What are common pitfalls in implementing \[specific algorithm]?"

***

## **3. Write SQL Queries**

Find product log events, database tables, and fields, and write SQL queries based on them.

**Examples:**

* "Write a SQL query to find all users who signed up in the last 30 days."
* "What are the column names in the \[table name] table?"
* "How do I join \[table A] and \[table B] to get \[specific data]?"
* "What are the most common errors in our database logs?"

***

## **4. Understand the Codebase**

Quickly locate code and repositories, and get summaries of implementation decisions.

**Examples:**

* "What does the function \[function name] do in the \[repository name] repository?"
* "Who wrote the \[specific module] and when?"
* "What are the dependencies for \[specific service]?"
* "Summarize the purpose of \[specific repository]."

***

## **5. Research Past Projects**

Get summaries of past RFCs, initiatives, KPIs, and next steps.

**Examples:**

* "What were the key decisions made in the \[project name] RFC?"
* "Summarize the goals and outcomes of the \[initiative name] project."
* "What were the KPIs tracked for \[specific feature]?"
* "What are the pending tasks for \[project name]?"

***

## **6. Find Experts in the Team**

Identify team members with domain-specific knowledge for guidance on projects or issues.

**Examples:**

* "Who worked on the \[specific feature] implementation?"
* "Who can help with debugging \[specific issue]?"
* "Who has experience with \[specific framework or tool]?"

***

## **7. Troubleshoot Deployment Issues**

Resolve deployment roadblocks by accessing internal documentation, runbooks, and cloud provider resources.

**Examples:**

* "What are the steps to deploy to \[environment name]?"
* "What does the error \[error code] mean in our deployment pipeline?"
* "Where can I find the runbook for \[specific service]?"
* "What are the rollback procedures for \[specific deployment]?"

***

## **8. Automate Repetitive Tasks**

Streamline workflows by automating common engineering tasks.

**Examples:**

* "Generate a boilerplate code for \[specific use case]."
* "Write a script to automate \[specific task]."
* "What are the steps to set up a CI/CD pipeline for \[project name]?"
* "How do I configure \[specific tool] for our project?"

***

## **9. Onboard New Engineers**

Help new hires ramp up quickly by providing access to documentation and key resources.

**Examples:**

* "What is the branching strategy for our Git repositories?"
* "Where can I find the documentation for \[specific service]?"
* "What are the coding standards for our team?"
* "What are the key tools and technologies used in our projects?"

***

## **10. Improve Code Quality**

Maintain high standards of code quality by accessing best practices and conducting code reviews.

**Examples:**

* "What are the best practices for writing unit tests in \[programming language]?"
* "How do I refactor this code to improve readability?"
* "What are common security vulnerabilities in \[specific framework]?"
* "What are the guidelines for writing maintainable code?"


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://support.dashworks.ai/use-cases/engineering.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
