Commit edb63a25 authored by Walter Heck's avatar Walter Heck

Merge branch 'documentation/reports' into 'master'

Documentation/reports

See merge request !28
parents 13eb0672 5624f4c2
# Why do we have this standard?
Documentation is one of the most crucial aspects of our jobs. We heavily rely on
it to understand new tools and technologies so it is very natural to strive for
this same level when delivering work to our customers. A well written
documentation is a very important, and visible, delivery item. It often serve as
a very good point of reference for internal usage and external display of our
core strengths.
# What do we expect to achieve?
OlinData is customer-driven company and, as such, our deliveries should always
deliver the biggest value to our final customer.
# Three steps that cover miles
1. Expand audience
Our documentation efforts should be as broad as our technical awesomeness is.
Our work is not to just deliver a solution, we also deliver knowledge.
1. Scientific approach
We should base our documentation in facts not concepts. By doing so, we'll
manage to always have a clear delivery without any misunderstandings.
1. Internal conversion
Documentation shouldn't only serve our customers, it's also a great wealth of
internal knowledge. Please check if there are content boundaries before
sharing it internally with OD's team.
# Why do we have this Standard?
Reports are usually read by non-technical people so they need to be written
differently, our technical prowess should be translated to a more direct and
concise overview of performed actions, delivered milestones and goal setting.
# What do we expect to achieve?
OlinData is customer-driven company and, as such, our deliveries should always
deliver the biggest value to our final customer. As consultants, we don't only
communicate with technical bodies, we often need to get in contact with managers
c-level executives and
# Three steps that cover miles
1. It is a broad overview
Reporting isn't documenting. Even though they're great allies to a proper
delivery, the report is done more often and also as an opener.
Ie.: Recon Phase
1. Scientific approach
Just like we should do with documentation, reports should reflect attainable
facts and forecasts. If you find this hard, stick to the original scope of
the project and go from there.
1. Execs like graphs
Reports are usually targeted towards executives and non-technical folks.
Therefore, is a great way to translate our tech awesomeness into
intelligible business talk.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment