Welcome the next person to a project.
Write a README that explains purpose, first use and where to ask for help.
Read the descriptive transcript
Follow the complete narration and the changes shown in the video. Each example can be copied.
1. A README welcomes the next reader
This project is a folder of garden records. The read me already explains what it is, how to open it and where to ask for help. It needs one example of use.
Source shown
# Garden notes
A folder of garden records.
## Start
Open notes.md in a text editor.
## Help
Ask the project maintainer.On screen
The cursor points to the source or its result while the explanation is narrated.
2. Add a small, usable example
Before Help, add Use. Put Water seedlings inside a text code fence. Now a newcomer can see what a note might contain.
Source shown
# Garden notes
A folder of garden records.
## Start
Open notes.md in a text editor.
## Use
```text
Water seedlings
```
## Help
Ask the project maintainer.On screen
The source changes one character at a time and the parsed preview updates.
3. Do not invent setup steps
There is no application to install here. Adding an install command would make the instructions less accurate. Describe the project you actually have.
Source shown
# Garden notes
A folder of garden records.
## Start
Open notes.md in a text editor.
## Use
```text
Water seedlings
```
## Help
Ask the project maintainer.On screen
The cursor points to the source or its result while the explanation is narrated.
4. Give the reader a next step
Help points to the project maintainer. For a real project, link to a known support channel. Do not invent an email address to make the document look finished.
Source shown
# Garden notes
A folder of garden records.
## Start
Open notes.md in a text editor.
## Use
```text
Water seedlings
```
## Help
Ask the project maintainer.On screen
The cursor points to the source or its result while the explanation is narrated.
5. Your turn: complete the README
Add the Use section in the practice document. Keep Start and Help. Then read it as someone opening the folder for the first time.
Source shown
# Garden notes
A folder of garden records.
## Start
Open notes.md in a text editor.
## Use
```text
Water seedlings
```
## Help
Ask the project maintainer.On screen
The cursor points to the source or its result while the explanation is narrated.
Answer a newcomer’s first questions
A README is often a project’s introduction: what it does, how to begin and where to get help. GitHub describes those uses in its README guidance. It is a filename convention, not a special executable format.
This fictional project is just a folder of garden records. A file called notes.md already exists. There is no application to install and no terminal command to run. Start with headings and code fences before this project.
Show a real first use
# Garden notes
A folder of garden records.
## Start
Open notes.md in a text editor.
## Use
```text
Water seedlings
```
## Help
Ask the project maintainer.The Start section tells the reader what to open. Use supplies a small example they can add. Help identifies a route to a person without inventing contact details. A real project can link to its actual support channel once that destination is known.
Match the instructions to the project
A convincing-looking npm install command would be wrong for this folder. Do not add setup commands, compatibility promises, licence claims or badges merely because other READMEs have them. Test real instructions in the environment you describe, and record prerequisites when they exist.
An AI assistant can draft sections from supplied facts. Review each claim and command against the actual project before publishing. Keep secrets, private paths and personal information out of copyable examples.
Practise a useful example
Add Use between Start and Help. Put Water seedlings in a text code fence. The checker looks for the introduction, populated sections and that example. It does not open a project or test installation.
Download a fuller README template and replace its fictional details. Keep only sections that help your reader.
YOUR TURN
Make the idea your own.
Add a Use section with a fenced text example containing Water seedlings. Keep the supplied Start and Help sections, and do not invent an installation command.
Readable result
Garden notes
A folder of garden records.
Start
Open notes.md in a text editor.
Help
Ask the project maintainer.
Compare with one possible answer
# Garden notes
A folder of garden records.
## Start
Open notes.md in a text editor.
## Use
```text
Water seedlings
```
## Help
Ask the project maintainer.This is one approach. Your writing can differ while meeting the same structural goal.
TAKE IT WITH YOU
A README should give the next reader a truthful first step.
Read the editor guide →Progress is stored in this browser. Your practice text is not saved.