> For the complete documentation index, see [llms.txt](https://help.aphex.co/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.aphex.co/docs/diary/web/diary-entries/contributing-to-a-diary-entry.md).

# Contributing to a Diary Entry

{% hint style="info" %}
**Who can use this feature?**

Any user configured as a Contributor on a diary can add content to entries.&#x20;
{% endhint %}

Contributing to a diary entry means adding the details of your day's work: which tasks you completed, how they progressed, materials used, and any notes or observations.&#x20;

<figure><img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2Ft8ZJODIDZ5sn1QrGwmW0%2FContribute%20to%20a%20diary.svg?alt=media&amp;token=2dd6060b-0cf7-47ee-bab6-e02927aeab9f" alt=""><figcaption></figcaption></figure>

## <img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FWHGjuanVlmOHA4cZ8aYQ%2F1%20Grey.svg?alt=media&amp;token=56471c5f-ac0f-4afb-9149-453a36097a85" alt="" data-size="line"> Open the Diary Entry

***

To begin contributing to a Diary Entry, you will need to either <a href="/docs/diary/web/diary-entries/creating-a-diary-entry.md" class="button secondary">Create a New Diary Entry</a> or open an existing diary entry that someone in your team has already created.

<figure><img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2Fh9sFzKLcXFs8wCRCuPVY%2Fopen%20entry.svg?alt=media&amp;token=e034b0fa-3971-48ee-8535-02766d93837d" alt=""><figcaption></figcaption></figure>

**To contribute to an existing diary entry:**

* Navigate to the <kbd>Diary Entries</kbd> tab
* Locate the existing Diary Entry you want to contribute to
* Click on the Diary Entry name to open the Entry Details
* Select <img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FaznAnJZQrUOP3UOOk2X2%2FText%20Buttons%20from%20Figma%20(1).png?alt=media&amp;token=ff6cf602-8dc4-4b92-90d0-b9ad85dac02c" alt="" data-size="line"> in the top right-hand corner

To open a new Diary Entry, see<a href="/docs/diary/web/diary-entries/creating-a-diary-entry.md" class="button secondary">Create a New Diary Entry</a>

<details>

<summary>How Diary Entry Contributors Work</summary>

You count as a contributor to a Diary Entry  the moment you add content (notes, photos, quantities, progress updates) to an entry - viewing alone doesn't make you a contributor.

</details>

<details>

<summary>Opening a Diary Rules</summary>

* If the Diary is **Open**, the option to <img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FaznAnJZQrUOP3UOOk2X2%2FText%20Buttons%20from%20Figma%20(1).png?alt=media&amp;token=ff6cf602-8dc4-4b92-90d0-b9ad85dac02c" alt="" data-size="line"> will show
* If the Diary is **Closed/Reviewed**, the option to <img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2Fp24ZXm2TpBRB2iXRtAr5%2Funlock.svg?alt=media&amp;token=7d600741-a0d3-41b8-88e8-0a0b860a8c4f" alt="" data-size="line"> the Diary Entry will appear
* Regardless of state, you can:
  * `Export` the entry
  * View `Diary History`
  * Use the `Overflow` menu to archive the Diary entry, or to navigate to the Diary itself

</details>

## <img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2Fx4scw3mIcnyLsn8g8MmY%2F2%20Grey.svg?alt=media&amp;token=f6db6b12-c9fd-4d08-bae0-e141912069da" alt="" data-size="line"> Select Tasks

***

This is where you record which tasks you worked on for the day. Selected tasks determine what you can log in later steps (progress, resources).

<figure><img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FwymKvAr1tocfwOl1Bo9x%2FSelect%20Tasks.svg?alt=media&amp;token=934f610e-219d-48e4-8295-b6f47c9c3aad" alt=""><figcaption></figcaption></figure>

**To add tasks:**

* Tap the <img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2F70gpXdtYImBKVFlvhCBx%2FIcon%20Buttons%20from%20Figma%20(1).png?alt=media&amp;token=2b8d4659-4db0-417c-9976-2f56985e2c09" alt="" data-size="line"> on suggested tasks that match your work for the day
* Click <img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FvhDJkTjQL0jJP91xhjXI%2FAdd%20Task.png?alt=media&amp;token=78643958-ba37-415b-99b5-dff0291d922d" alt="" data-size="line"> to find specific tasks
* In the search screen, use<img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2F1uSzhSb5aSNnZd5vTaGB%2FFilter%20Button.svg?alt=media&amp;token=8ddd7f1c-0296-4af2-bdeb-d08d56fc56b6" alt="" data-size="line"> to narrow results
* To create a new task, click <img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FrVdFJ5mimdrFMz3boUNa%2FCreate%20Unplanned%20Task.png?alt=media&amp;token=45f02b7c-7003-40e2-be7c-ec0c645484c5" alt="" data-size="line">
* Selected tasks show a blue checkmark <img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2Fmqd0Es0P25FJnYpgLh73%2FIcon%20Buttons%20from%20Figma.png?alt=media&amp;token=6fddb314-dd61-4a60-8efa-1d96edec5360" alt="" data-size="line">  and move to the top Selected Tasks section

<details>

<summary>Task Selection Rules</summary>

* Suggested tasks appear based on who's working and historical pattern
* The same task can be worked on across multiple entries
* Search by task name or ID
* Once selected, a tag shows who selected the task

</details>

<details>

<summary>How Unplanned Tasks Work</summary>

Users can create Unplanned Tasks via the Task Search modal if a Task does not already exist in the Project.

Unplanned Task Rules:

* Any Contributor can create an Unplanned Task
* Unplanned Tasks exist solely within the specific Diary Entry where they are created. They are not added to the Project’s Plan and do not carry over as Suggested Tasks for future Entries
* Unplanned Tasks are defined only by their Task Name. They do not hold any other properties (like Owner or Dates etc).&#x20;
* Progress Updates cannot be added and Material Actual History will not be visible for Unplanned Tasks.

</details>

## <img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2Fz0xFokg3mMNUa5YFeFPq%2F3%20Grey.svg?alt=media&amp;token=8c7ad95f-9887-4530-8006-d8b807c108da" alt="" data-size="line"> Progress Updates

***

Log how tasks progressed during your shift: on track, delayed, or ahead of schedule.

<figure><img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FJesZL4zq6igZg8Qle4hO%2FStep%202%20-%20Progress%20Updates.svg?alt=media&amp;token=c2efa3bf-970e-4c4f-9559-cb530c1f4942" alt=""><figcaption></figcaption></figure>

**To make progress updates:**

* Review tasks that already have progress logged
* For tasks needing an update, tap the 'on schedule' <img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FdR0lJrFqzXRkwq77leCL%2FThumbs%20Up.svg?alt=media&amp;token=0b23234b-417e-4771-917f-6ea5a8299c64" alt="" data-size="line"> or 'delayed '<img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FZpw6cJW8Cg2BiiaJP5Ua%2FStatus%20Buttons.svg?alt=media&amp;token=af2f2296-758f-428c-b53f-c71328d40ced" alt="" data-size="line"> icon
* Select the impact: On Schedule, Delayed by days, Moved earlier, Shortened
* Enter the number of days (if applicable)
* Add a comment describing the change
* Select <img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FylSP9U4xxpeEOMQR9VoC%2FConfirm.svg?alt=media&amp;token=5140283e-75fe-418e-a945-4e5f817c1bf2" alt="" data-size="line">

<details>

<summary>Progress Update Rules</summary>

* This step is only visible if "Task Progress Updates" is enabled in Diary Steps
* Progress updates appear on the task in real-time for all users
* Deleted progress is removed from both the entry and the task

</details>

## <img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2F8spmtZY3piARidsDCwrR%2F4%20Grey.svg?alt=media&amp;token=355fe092-0b22-4c78-aa59-ebf7e6706f03" alt="" data-size="line"> Record Material Quantities

***

For each Planned Material allocated to a Linked Task, diary contributors can record Material Actuals against.

<figure><img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FrZqymUfCEXjxtHddiZL6%2FMaterial%20quantities.svg?alt=media&amp;token=c7d0e4c5-197f-446b-814b-6d1419309ad3" alt=""><figcaption></figcaption></figure>

**To record Planned Material Quantities against tasks:**

* Locate the task you want to record actual material quantities for
* Enter the actual quantity, or click ![](https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FabTzKZrN4f3pgpaqbzfd%2Frecent.svg?alt=media\&token=4a59b38c-d597-4ad2-a066-3923a9a5d06c) to browse recent inputs

**To record Unplanned Material Quantities against tasks:**

* Locate the task you want to record an unplanned material quantities for
* Select <img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2F5wB6i0onn0LYpepOnuGF%2FAdd%20Unplanned%20Quantity%20(1).png?alt=media&amp;token=7cd83a2a-849c-427f-b327-1c1926576915" alt="" data-size="line"> and select the material from the dropdown
* Input the material quantity

<details>

<summary>Material Quantity Rules</summary>

* Any named diary contributor will automatically have permission to add quantities to a Task&#x20;
* Actuals logged across all Diaries will always be reflected on the Task in Planner
* If the Task is Unlinked from the Entry, any associated Actuals will be automatically removed from the Entry (and from the Task)
* Any Actuals added to an Entry will not be included in the data sent via the Power BI API

</details>

## <img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2F9OJodh5gXwsZtz47NemJ%2F5%20Grey.svg?alt=media&amp;token=ef387f89-206c-4bb3-8e65-95f2165dd70b" alt="" data-size="line"> Record Labour & Plant Details

***

Record actual Labour and Plant details for the day.

<figure><img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FWXQHvyZ0cFCB07vdUAly%2FRecord%20labour.svg?alt=media&amp;token=0b1ee4c4-82ce-449c-b53a-d6e31852bfb7" alt=""><figcaption></figcaption></figure>

**To add Labour & Plant details:**

* Tap the <img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2Fob4Sez2Wihkl5sahPIAh%2FPlus.svg?alt=media&amp;token=00270513-d32b-4f4a-b607-b4f81347ac4a" alt="" data-size="line">
* Input the required <mark style="color:$danger;">\*</mark> and optional Labour or Plant details
* Tap ![](https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2F0aWlVTv4VMhdRXci7uXF%2FSave.svg?alt=media\&token=bb037987-51f5-4489-b9f0-0319af2d4042)

<details>

<summary>Labour &#x26; Plant Details Rules</summary>

* Name and Quantity details are required. Without inputting these details, the record will not save.
* Additional labour and plant fields (Type, Start Time, End Time, Cost Code etc) can be added from the Diary settings. See <a href="/docs/diary/getting-started.md" class="button secondary">Getting Started in Diary</a>

</details>

## <img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FHxikXh9gahXrQxOo4UwU%2FGrey%206.svg?alt=media&amp;token=fecf0f66-8d09-4643-9f04-a2111118dc7f" alt="" data-size="line"> Add Notes & Photos

***

Link related notes and photos to the Diary Entry.&#x20;

<figure><img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FqlBws3yLuwn8AVhfeCVc%2FAdd%20notes.svg?alt=media&amp;token=1319fe8f-489c-44cd-9035-653d720ff6ae" alt=""><figcaption></figcaption></figure>

**To add a note or image:**

* Select <img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FgXhxwZBVbHTxKh7vx3uB%2FAdd%20Notes%20%26%20Images.png?alt=media&amp;token=1c13ae66-1011-4fc4-b5d7-a45effddc33f" alt="" data-size="line"> and choose which note you'd like to attach
  * <kbd>Image to Text</kbd>: Take a photo of handwritten notes to be generated into text
  * <kbd>Voice to Text</kbd>: Speak into the microphone to generate a transcribed note
  * <kbd>Write Note</kbd>: Type a note to add to the Diary Entry
  * <kbd>Image</kbd>: Upload JPG or PNG files from your computer
  * <kbd>Add from Your Clipboard</kbd> : Attach images you have added to previous Diary Entries

**To link notes and images to a task:**

* Locate the note or image you wish to link, and click ![](https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FTU7XaMe5QREhK7zDMqPk%2FIcon%20Buttons%20from%20Figma.svg?alt=media\&token=814e0413-eadd-4377-9c64-09ef5ee5ea64) beneath it
* Select the related task

**To link multiple tasks to one note or image:**

* Hover over the image or note and select <img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FunU6FaTKiBE8xXhg6N0j%2Foverflow%20button.svg?alt=media&amp;token=5a3f3ce9-9039-4119-a28e-f4d2a2189ced" alt="" data-size="line">
* Select <kbd>duplicate</kbd>
* Link the duplicated note to the second task

<details>

<summary>Note &#x26; Image Rules</summary>

* Each clip can be linked to one Task only
* A Task can have multiple clips linked to it
* Notes and Captions can only be edited by the author

</details>

## <img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FwdbXLn2XjOdRvBQlGn6M%2FGrey%207.svg?alt=media&amp;token=31499407-2a88-4295-bd52-ff014ebd6830" alt="" data-size="line"> Generate Summary

***

Review an AI-generated summary of your entry, or write one manually.

<figure><img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FVuazy7SC8nBjnx9Tvwp9%2FSummary.svg?alt=media&amp;token=5fd5e6b2-458e-4ce5-8b16-875c98fdf348" alt=""><figcaption></figcaption></figure>

**To generate a summary:**

* Click <img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FeMN5IanIcuPme8826ETT%2FGenerate.svg?alt=media&amp;token=7afab117-8c05-46e8-840a-2bcd417cfa20" alt="" data-size="line"> to draft an AI-generated summary
* Review the generated summary and add any additional details
* Alternatively, manually type the summary in the text box

**To update the summary:**

* If any changes are made to the Diary Entry, you will need to update the generated summary
* Click ![](https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FsL0ZO5upZsniADRC5QLc%2FUpdate%20from%20Figma.svg?alt=media\&token=08f2b698-f920-4476-83c7-ffc55f106c39) from the <kbd>Summary</kbd> tab in the left-hand panel

<details>

<summary>Summary Rules</summary>

* The AI-generated summary will cover the following categories:
  1. **Delays & Disruptions** (always first if present)
  2. **Meetings & Inspections**
  3. **Safety, Quality, or Environmental Issues**
  4. **General Notes** (always last if present, only when no other category fits)
* When clicking on ‘Regenerate’, the existing summary remains unchanged. Any new data (from progress or clips) are added to the bottom of each relevant category.

</details>

## <img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FVWtN8XrhLrWNiwd7MHas%2F8%20Grey.svg?alt=media&amp;token=9d8bb709-fa72-4661-848c-3cbcecead2c8" alt="" data-size="line"> Review & Submit

***

Once all contributors have updated the diary entry for the day, the next step is to review and submit the diary. It is the responsibility of the contributors to either lock, or submit the entry for review at the end of each day.&#x20;

<figure><img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2Fu8zEeivZNvpzk8uMvLpn%2FLock%20diary.svg?alt=media&amp;token=3589663a-e766-4241-8ee7-9fa677b63d82" alt=""><figcaption></figcaption></figure>

**To Review & Submit the Diary Entry:**

* Review the diary entry details and confirm that all information is correct
* If information needs to be updated, navigate back to the relevant section and make any changes
* Once reviewed, click <img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FNOOTw4AvDLtZqtGaLgux%2FLock%20diary.svg?alt=media&amp;token=aa8b5e1e-e91d-418b-bfb7-c0ce47e71e22" alt="" data-size="line">

Note: If your Diary has one or more Reviewer assigned, you will be prompted to <img src="https://2273109354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLu0mYklsCTm7XQm3ZGqv%2Fuploads%2FEscKeUEGy1kDedItFfgW%2FSubmit%20for%20Review.svg?alt=media&amp;token=c9b193ba-96a7-4baf-b85c-2e132706598b" alt="" data-size="line"> instead

<details>

<summary>Locking &#x26; Submitting Diary Entry Rules</summary>

* Diary entries can be locked and unlocked by any named Contributors on the Diary
* Once the Diary Entry has been Submitted for Review, only Reviewers can re-open the Diary Entry

</details>

## Next Steps

***

If the diary has one or more reviewers assigned, they can now go and <a href="/docs/diary/web/diary-entries/reviewing-a-diary-entry.md" class="button secondary">Review the Diary Entry</a>.&#x20;


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://help.aphex.co/docs/diary/web/diary-entries/contributing-to-a-diary-entry.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
