# Documentation best practices

**URL:** <https://community.glideapps.com/t/documentation-best-practices/60125>\
**Category:** Ask for Help\
**Created:** [April 4, 2023, 1:05pm UTC](https://community.glideapps.com/t/documentation-best-practices/60125 "2023-04-04T13:05:27Z")\
**Posts on this page:** 5\
**Page:** 1

<div class="post-metadata">

**Author:** ![CouscousOps](https://sea2.discourse-cdn.com/flex002/user_avatar/community.glideapps.com/couscousops/32/55751_2.png) [@CouscousOps](https://community.glideapps.com/u/CouscousOps)\
**Post date:** [April 4, 2023, 1:05pm UTC](https://community.glideapps.com/t/documentation-best-practices/60125/1 "2023-04-04T13:05:27Z")

</div>

Hi all! I’ve been in the process of building my team a project management app. It’s working well and my team is hoping to scale it to the rest of the department. I would like to make sure I have things documented so I can knowledge share with others. Would love to have another point person maintaining the app if I ever leave or go on vacation. Anyone have any guidance on documentation best practices (fields, tables, automations, etc.)?

---

<div class="post-metadata">

**Author:** ![DarrenHumphries](https://sea2.discourse-cdn.com/flex002/user_avatar/community.glideapps.com/darrenhumphries/32/91715_2.png) [@DarrenHumphries](https://community.glideapps.com/u/DarrenHumphries)\
**Post date:** [April 4, 2023, 1:21pm UTC](https://community.glideapps.com/t/documentation-best-practices/60125/2 "2023-04-04T13:21:27Z")

</div>

That’s a great question but I have to admit I’m guilty of not doing this. Anyone done Glide specific documentation?

---

<div class="post-metadata">

**Author:** ![Eric\_Penn](https://sea2.discourse-cdn.com/flex002/user_avatar/community.glideapps.com/eric_penn/32/73888_2.png) [@Eric\_Penn](https://community.glideapps.com/u/Eric_Penn)\
**Post date:** [April 4, 2023, 2:34pm UTC](https://community.glideapps.com/t/documentation-best-practices/60125/3 "2023-04-04T14:34:39Z")

</div>

A good practice is to use column grouping in the data editor.

> **[Glide • Introduction to Data Editor](https://www.glideapps.com/docs/guides/core/introduction-to-the-data-editor)**
>
> The Data Editor is where you manage your project's data. You can edit in the Data Editor or wherever the data is stored. Everything stays in sync.

If you insert a forward slash in the column name I.e. rollup/day rollup/month rollup/year… rollup will become a group label.

This makes it much easier to work with data in the editor as it allows you to collapse groupings. It also allows us to search our data very efficiently. Given the example above if I search in the editor for ‘rollup’ I would find every rollup column used by my app.

Abbreviations for column types is also a nice touch i.e.

ru → rollup  
rel → relation  
lu → lookup  
mth → math

Etc…

Another approach could be to group by a feature instead of a column type… feature1/ feature2/

Not exactly the documentation you are looking for but should definitely help improve productivity.

---

<div class="post-metadata">

**Author:** ![CouscousOps](https://sea2.discourse-cdn.com/flex002/user_avatar/community.glideapps.com/couscousops/32/55751_2.png) [@CouscousOps](https://community.glideapps.com/u/CouscousOps)\
**Post date:** [April 4, 2023, 4:01pm UTC](https://community.glideapps.com/t/documentation-best-practices/60125/4 "2023-04-04T16:01:08Z")

</div>

Thank you so much! This is already eons better than what I’m doing now. Looks like I have some field name auditing to do 🙂

---

<div class="post-metadata">

**Author:** ![ThinhDinh](https://sea2.discourse-cdn.com/flex002/user_avatar/community.glideapps.com/thinhdinh/32/49_2.png) [@ThinhDinh](https://community.glideapps.com/u/ThinhDinh)\
**Post date:** [April 5, 2023, 12:41am UTC](https://community.glideapps.com/t/documentation-best-practices/60125/5 "2023-04-05T00:41:00Z")

</div>

I would suggest using a solution like [Scribe](https://scribehow.com/) to do your documentation. I think making it as visual as you can will be a good start.
