> For the complete documentation index, see [llms.txt](https://karim-ashraf.gitbook.io/karim_ashraf_space/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://karim-ashraf.gitbook.io/karim_ashraf_space/writeups/lets-defend/incident-responder-path/writing-a-report-on-security-incident/report-formatting.md).

# Report Formatting

## **Report Formatting Guidelines for Professional and Consistent Technical Documentation**

Maintaining a consistent and professional format is crucial for enhancing the clarity and readability of technical reports. Below are detailed formatting guidelines to ensure your reports meet professional standards.

***

## **1. Date and Time**

**Consistency in Date Format**

Use a uniform date format throughout the report to avoid confusion.

* **Preferred**:
  * June 16, 2022
* **Avoid**:
  * 16/06/2022 or 2022-06-16

**Time and Timezone**

Always include the timezone to provide clear context for event timing.

**Example**:

* 06:12 GMT+2

***

## **2. Font**

**Readable and Professional Fonts**

* **Headings**: Use fonts like **Verdana Bold** or **Arial Bold** for better distinction.
* **Body Text**: Use professional fonts such as **Arial**, **Calibri**, or **Times New Roman**.
* **Avoid Informal Fonts**: e.g., **Comic Sans**, **Papyrus**.

***

## **3. Tables and Visuals**

**Tables**

Tables are effective for organizing and presenting structured data. Ensure consistency in formatting and labeling.

**Example Table**:

| **Host**   | **Compromise Details**           |
| ---------- | -------------------------------- |
| SusieHost  | Detected malware: mimikatz.exe   |
| Web-Server | Unauthorized login: 192.168.1.20 |

**Visuals**

Charts, screenshots, or network diagrams should be clearly labeled and referenced within the text.

**Example**:

* **Figure 1: Network Layout**

***

## **4. Data Details**

When providing technical information about files or artifacts, ensure uniformity in the level of detail presented for each item.

**Example: File Details**:

| **Detail**        | **Value**                                |
| ----------------- | ---------------------------------------- |
| **Filename**      | mimikatz.exe                             |
| **SHA256 Hash**   | 3f786850e387550fdab836ed7e6dc881de23001b |
| **Creation Date** | June 15, 2022                            |
| **Path**          | C:\Windows\Temp\mimikatz.exe             |

Repeat these fields for each file mentioned in the report.

***

## **5. Lists**

Use bullet points or numbered lists to present information clearly and concisely.

**Examples**

**Numbered List for Tools**:

1. mimikatz.exe
2. nc.exe
3. powershell.exe

**Bullet List for Hosts**:

* SusieHost
* GitServer
* Web-Server

***

## **6. General Layout**

**Headings and Subheadings**

Use clear headings and subheadings to organize the report logically.

**Examples**:

* **Incident Summary**
* **Root Cause**
* **Mitigation Steps**

**Page Numbers**

Include page numbers in the **footer** for easy reference.

**Consistent Margins**

Use standard margins (1 inch or 2.54 cm on all sides) to maintain a clean and professional appearance.

***

### **Key Points** 

By adhering to these formatting guidelines, you ensure your technical reports are:

* **Professional**: Align with industry standards.
* **Consistent**: Facilitate quick navigation and comprehension.
* **Actionable**: Provide clear, structured information for decision-making and future reference.