Skip to content

Commit

Permalink
overwrite README.md with latest #23
Browse files Browse the repository at this point in the history
  • Loading branch information
nelsonic committed Jul 8, 2023
1 parent 778c720 commit e7d22b5
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 17 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ node_modules

haters
takers

67 changes: 50 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<<<<<<< HEAD
alvo
=======

Expand Down Expand Up @@ -66,31 +67,63 @@ That's it! it reads like english!
**Q**: *What* are the **#** (*hash*) simbols?
**A**: They are the id's of the form elements on the *contact* page.
(hint: *Scroll down* to the ***glossary*** to learn more)
=======
<div align="center">
<img src="https://github.com/dwyl/atm/assets/194400/1d71bfb3-1c55-46f0-8c0e-b72b725937bd" height="300">
<h1>**A**ctionable **T**imely **M**etrics.</h1>
>>>>>>> 5104fda (add intro logo see: https://github.com/dwyl/atm/issues/23#issuecomment-1626997323 🏧)


</div>

# Why? 🤷‍♀️

We needed a **_much_ better way**
of **tracking, viewing and _acting_ on**
**metrics** in our projects.

## Data Driven? 🙈

After **20 years** of working
in Web Application/Site Development,
with more than 100 project teams and organizations
we've noted one alarming fact:

**_Most_ Product Owners don't _check_ Google Analytics**
and use the **insights** to **_drive_ decisions**.



If the **_leaders_ aren't data driven**,
_nobody_ `else` in the team will be.
And ultimately the project/product will fail.
Or if it succeeds,
it will be _despite_ the leaders.


# What?

More detail in: https://github.com/dwyl/atm/issues/16


### *Easily* Record How you *Use* a Website or Web Application

When the page loads we register:
## Name? 🏧

+ Client's Browser + Version (full user-agent string & short name)
+ Page URL
+ Client ViewPort (width/height of browser window) dimensions
+ IP address of the client (all server logs store this)
"ATM" stands for "Actionable Timely Metrics" (_this is a ["backronym"](https://en.wikipedia.org/wiki/Backronym)). We **really** wanted to give this project a name that is both short, _memorable_ and helps stakeholders _understand_ the importance of analytics data to the organisation!

Track/record actions performed on the page

- Page scroll (distance scrolled from the top)
- Click/Touch events [x,y], element type and class, id and name
![free-cash-withdrawals](https://github.com/dwyl/atm/assets/194400/78fda825-5f71-4eed-8738-aef033829d7c)

What happens to this data?
# Who?

- Save this data to local storage / cookie so a person can track their *own* history.
- Send data over WebSocket to server
+ Relay event log to connected obeservers (with permission)
This project aims to both _simplify_ the language/vocabulary around analytics/metrics and create a simple way of tracking _any_ event in _any_ web app.

## Project Name
If it's not _immediately obvious_ **Why** this project is valuable and **How** it works,
we have failed. So if you are scratching your head wondering: "_Is this for **me**?_" ...
**please _help_ us** by describing your situation so we can **_help_ you** realise the _value_ of the data you are sending to Google Analytics and then _ignoring_...

> "*All the good names are taken.*"
# How?

[***alvo***](https://translate.google.com/#auto/en/alvo) means "target".
And since we are
+ [ ] Define the basic schema for an Events (Analytics) Table!
+ [ ] Implement it!

0 comments on commit e7d22b5

Please sign in to comment.