From 73b47284c994593981668dedcc8548bbc19c4fc6 Mon Sep 17 00:00:00 2001 From: James Pond Date: Mon, 29 Jul 2024 13:12:24 -0300 Subject: [PATCH 1/2] Tweak the draft prompt to generate better drafts In my tests, these changes resulted in less "bullet-pointy" articles. Signed-off-by: James Pond --- internal/prompt/data/draft-prompt.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/internal/prompt/data/draft-prompt.txt b/internal/prompt/data/draft-prompt.txt index 0590dc4..68752b8 100644 --- a/internal/prompt/data/draft-prompt.txt +++ b/internal/prompt/data/draft-prompt.txt @@ -1100,11 +1100,11 @@ Now, follow these steps to create the technical documentation: - Ensure a natural flow between sections, avoiding abrupt transitions. 2. Content creation: - - Transform the provided notes into full, coherent paragraphs. + - Transform the provided notes into coherent full sentences and paragraphs. Avoid using bullet points unless absolutely necessary for clarity. - Expand on key concepts, providing clear explanations and context. - Use technical language appropriate for the target audience, as specified in the style guide. - Include relevant examples or use cases to illustrate complex ideas. - - Avoid overuse of bullet points; instead, integrate list-like information into flowing paragraphs when possible. + - Integrate list-like information into flowing paragraphs when possible, using transitional phrases and sentences to connect ideas. 3. Style and formatting: - Adhere strictly to the provided style guides for formatting, terminology, and tone. @@ -1314,4 +1314,4 @@ Datadog ASM identifies Log4j Log4Shell attack payloads and provides visibility i [27]: /tracing/api_catalog/ ``` -Remember to maintain Datadog's commitment to clarity, accuracy, and user-friendliness throughout the documentation. Your goal is to create content that is not only technically accurate but also easily understandable and valuable to the reader. +Remember to maintain Datadog's commitment to clarity, accuracy, and user-friendliness throughout the documentation. Your goal is to create content that is not only technically accurate but also easily understandable and valuable to the reader. Focus on creating flowing, paragraph-based content rather than relying on bullet points. From 66433cd93a8e2ec1fd3eb1c6fb7f0b22e36b8c5b Mon Sep 17 00:00:00 2001 From: James Pond Date: Mon, 29 Jul 2024 13:13:05 -0300 Subject: [PATCH 2/2] Tweak review prompt to decrease false positives Feedback from the team led me to find out the AI was flagging HTML tags and other attributes, which isn't what we're looking for. This new set of instructions should help with that. Signed-off-by: James Pond --- internal/prompt/data/review-prompt.txt | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/internal/prompt/data/review-prompt.txt b/internal/prompt/data/review-prompt.txt index 326d525..51a2286 100644 --- a/internal/prompt/data/review-prompt.txt +++ b/internal/prompt/data/review-prompt.txt @@ -1094,8 +1094,13 @@ When reviewing the technical document, follow these steps: 1. Read the entire document carefully. 2. Identify any issues related to standard English, correctness, markdown syntax, clarity, grammar, or style guide violations. -3. For each issue, provide a description, a suggestion for improvement, and any additional comments or context. -4. Consider other ways to improve the document while adhering to the style guide. +3. Do not flag or attempt to correct any of the following: + a. Parameters in Markdown shortcodes ( e.g. `{{< callout url="#" btn_hidden="true" header="Try the beta!" >}}`). + b. Parameters in front matter (e.g. `further_reading:`). + c. HTML tag attributes (e.g. `
`). +4. Review and potentially flag the content within the HTML tags, not the tags themselves or the attributes. +5. For each issue, provide a description, a suggestion for improvement, and any additional comments or context. +6. Consider other ways to improve the document while adhering to the style guide. IMPORTANT: Your output should be in Markdown format with the following structure, and nothing else. It must strictly adhere to the structure below. Ignore the backticks, they're just there to show you the structure. Do not include backticks in your output.