Every change to a document or code must have a comment. This comment explains why the change happened. All feedback received must be recorded in a log.
By Pawan Nayar · from the LLOS AI Learning record
Every change to a document or code must have a comment.
This comment explains why the change happened. All feedback received must be recorded in a log.
A developer should add comments to code changes. These comments explain the reason for the change. The developer should also keep a log of all feedback. This log helps remember past decisions. It prevents the same feedback from being given again.
A developer receives feedback to change a paragraph in a document. The developer changes the paragraph. The developer adds a comment next to the change. The comment says, '// [date] Developer: Changed paragraph based on user feedback.' The developer also adds the feedback to a 'FEEDBACK_LOG.md' file. This log includes the date, the exact feedback, and what action was taken. This way, the reason for the change is clear. The feedback is also recorded for future reference.
Resolved from this lesson's own record — real definitions, not invented for this page.
More from the same record, pulled by shared topic — not written new for this page.
Record feedback in a log. Each entry needs a date.
Create an append-only log file. Each entry needs a date, a summary, the feedback itself, and the action taken.
A project's test plan and all rules must be kept inside the project folder. This makes sure everyone working on the project can find them easily.
An AI model can become inconsistent when its design documents do not match. For example, one document might say there are 25 chapters.
Every change to a document or code must have a comment. This comment explains why the change happened. All feedback received must be recorded in a log.