Make generate-tasks.md language agnostic for more general use (& front matter) #57
Description
I followed the demostration of this PRD-task system to guide and document working with AI.
One thing I noticed was that the generate-tasks.md file wasn't really language agnostic. The specifications given in the section "output format" using typescript file extensions as well as the reference to jest for testing as well as the instruction to place the unit tests next to the code conflicted with previous instructions the AI in my first test on a python project.
Therefore, I suggest to make the instructions file agnostic and, if necessary, outsource language-, AI config- (e.g. reasoning effort in ChatGPT), or project structure-related instructions into a separate file, adding only a reminder to follow those instructions in generate-tasks.md.
PS:
I modified it the output files to include front matter. I like to include the metadata for the purpose of documentation and Good Laboratory Practice. It also helps organizing when working in Obsidian.
# mandatory
doc_type: "<prd|task>"
id: "<[n]>"
slug: "<your-document-title>"
version: "1.0.0"
# optional
title: "<Document Title>"
description: "<One to three lines summarizing the document>"
# mandatory
author:
user_name: "<Name||from git config user.name if available; else ''>"
user_email: "<[email protected]>"
org: "<optional Your Org>"
# mandatory
ai:
ai_model: "<current assistant model name (e.g., GPT-5 Thinking)>"
generated_at: "<ISO 8601 timestamp in Europe/Berlin>"
# optional, but recommended at least with one placeholder
contributors:
- { name: "Reviewer One", role: "review" }
- { name: "Contributor Two", role: "edit" }
tags: ["feature", "<prd|task>", "<tag3>", "<tag4>", etc.]
# optional, but recommended
links:
repo: "<https://github.com/your/repo>"
issue: "<https://tracker/issue/123>"
pr: "<https://github.com/your/repo/pull/456>"
doc: "<path/to/doc/file1.{ext} || https://internal.wiki/page>"
dataset: "<path/to/dataset/file1.{ext} || link_to_remote_depository>"
related: "<List of related documents, e.g. `[n]_prd_[feature-name].md` >"
# default should be internal
confidentiality: "<public|internal|restricted>
license: "<See LICENSE.md or README.md>"
changelog:
- { version: "1.0.0", date: "<ISO 8601 timestamp>", note: "Initial draft." }