5. Project Structure

Guidance on organizing project folders, creating README files, and managing scripts in production.

---

5.1 README Structure

Folder-Level Docs

• Include a README describing contents and usage
• Maintain consistent formatting (Markdown headings, code blocks)

References

• Link to scripts, environment instructions, external docs

---

5.2 Scripts Development

Production Code

• Ensure logging, error handling, performance considerations

Code Style Conventions

• PEP8 (if Python)
• Linters/formatters (black, flake8, etc.)

Docstrings

• Function-level docstrings with parameter and return descriptions