jim/openai-cookbook
1
0
Fork 0
mirror of https://github.com/james-m-jordan/openai-cookbook.git synced 2025-05-09 19:32:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add conciseness metric to rubric. (#925)

Browse Source 
Co-authored-by: Will DePue <will@depue.net>
This commit is contained in:
Ilan Bigio 2023-12-19 12:08:18 -05:00 committed by GitHub
parent 70aaa3a917
commit 2bd7585bc8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -31,16 +31,18 @@ For additional advice on writing good documentation, refer to [What Makes Docume
| Uniqueness | Does the content offer new insights or unique information compared to existing documentation? | | | Uniqueness | Does the content offer new insights or unique information compared to existing documentation? | |
| Clarity | Is the language easy to understand? Are things well-explained? Is the title clear? | | | Clarity | Is the language easy to understand? Are things well-explained? Is the title clear? | |
| Correctness | Are the facts, code snippets, and examples correct and reliable? Does everything execute correctly? | | | Correctness | Are the facts, code snippets, and examples correct and reliable? Does everything execute correctly? | |
| Conciseness | Is the content concise? Are all details necessary? Can it be made shorter? | |
| Completeness | Is the content thorough and detailed? Are there things that weren’t explained fully? | | | Completeness | Is the content thorough and detailed? Are there things that weren’t explained fully? | |
| Grammar | Are there grammatical or spelling errors present? | | | Grammar | Are there grammatical or spelling errors present? | |
### Breakdown ### Breakdown
| Criteria | 4 | 3 | 2 | 1 | | Criteria | 4 | 3 | 2 | 1 |
| ------------ | -------------------------------------- | ---------------------------------------- | --------------------------------------------- | ------------------------------------- | | ------------ | --------------------------------------------- | ----------------------------------------- | --------------------------------------------- | ------------------------------------------ |
| Relevance | Relevant and useful. | Relevant but not very useful. | Tangentially relevant. | Not relevant. | | Relevance | Relevant and useful. | Relevant but not very useful. | Tangentially relevant. | Not relevant. |
| Uniqueness | Completely unique with fresh insights. | Unique with minor overlaps. | Some unique aspects, but significant overlap. | Many similar guides/examples. | | Uniqueness | Completely unique with fresh insights. | Unique with minor overlaps. | Some unique aspects, but significant overlap. | Many similar guides/examples. |
| Clarity | Clear language and structure. | Clear language, unclear structure. | Some sections unclear. | Confusing and unclear. | | Clarity | Clear language and structure. | Clear language, unclear structure. | Some sections unclear. | Confusing and unclear. |
| Correctness | Completely error free. | Code works, minor improvements needed. | Few errors and warnings. | Many errors, code doesn't execute. | | Correctness | Completely error free. | Code works, minor improvements needed. | Few errors and warnings. | Many errors, code doesn't execute. |
| Conciseness | Cannot be reduced in any section, or overall. | Mostly short, but could still be reduced. | Some long sections, and/or long overall. | Very long sections and overall, redundant. |
| Completeness | Complete and detailed. | Mostly complete, minor additions needed. | Lacks some explanations. | Missing significant portions. | | Completeness | Complete and detailed. | Mostly complete, minor additions needed. | Lacks some explanations. | Missing significant portions. |
| Grammar | Perfect grammar. | Correct grammar, few typos. | Some spelling/grammatical errors. | Numerous spelling/grammatical errors. | | Grammar | Perfect grammar. | Correct grammar, few typos. | Some spelling/grammatical errors. | Numerous spelling/grammatical errors. |