Documentation and Storytelling
External Resources
-
Writing skills practice - https://learnenglish.britishcouncil.org/skills/writing
-
Grammar check for documentation - https://www.grammarly.com/
-
Few references for Documentation and Storytelling-
Projects-
- https://jovian.ai/harshit-gupta3085/final-web-scraping-project
- https://jovian.ai/anushree-k/restaurant-listings-notebook
- https://jovian.ai/tejasvi-sadasivuni/project1-yahoo-stock-prices
Blog posts-
Common Questions
Q1: What does outline mean in a project?
A: Outline simply says what you're going to do in your project. It summarizes the steps you're going to follow. In short, describing your project in 5 sentences.
Q2: Is there any way to get grammarly work on Jupyter?
A: Unfortunately, no. Instead, you can copy-paste your content in an online spell checker and correct the mistakes.
Q3: Can we group pip installs and imports in a single code block?
A: No, that'll cause problems. Instead, one code block for all installations and one code block for all imports can be done.
Q4: Usually what kind of tones can we use for documentation?
A: It is upto you. You can write up documentation with technical or non-technical or both kinds of content - depends on the kind of audience you're targeting for.
Q5: What is the best way to stop execution on exceptions so that the stack trace shows the source of the error?
A: What Python shows you when your code runs into an error is already good enough.