Project Documentation¶
This site provides project documentation. Use the documentation navigation to explore.
How-To Guide¶
Many instructions are common to all our projects.
See ⭐ Workflow: Apply Example to get the example projects running on your machine.
Project Documentation Pages (docs/)¶
- Home - this documentation landing page
- Project Instructions - the standard project workflow
- Your Files - how to copy the example and create your version
- Glossary - project terms and concepts
- API - autogenerated code documentation for the public project interface
Phase 4. Technical Modification¶
Describe your small technical modification to the example project.
Include:
- What you changed
- Why you chose that change
- How you verified that it worked
- What result, output, chart, metric, or behavior confirmed the change
Compared with the example project, explain what is different and why the change matters.
Was it easy, or surprisingly challenging and why do you think so?
Phase 5. Custom Project¶
Describe your custom data cleaning and preparation work.
Basis and Data¶
Describe the raw data you started with.
Include:
- The three smart sales data files and their known quality issues
- Which issues you chose to address and which you deferred
- Any important assumptions about what counts as valid data
Cleaning Approach¶
Describe the ETVL preparation steps you implemented.
Include:
- What cleaning steps you applied to each table
- What custom cleaning logic you added beyond the example
- How you verified the data was clean before saving
Before and After¶
Describe the impact of your cleaning work.
Include:
- How many rows were removed or corrected in each table
- What the data looked like before and after (use screenshots or log output)
- Whether any cleaning decisions were judgment calls and why you made them
Summary¶
Summarize your custom cleaning work.
Include:
- What you implemented beyond the example
- What the prepared data looks like
- What you learned about data quality
- What kinds of real business problems data cleaning enables
Display at least one chart or screenshot showing your before and after results.