Skip to content

Commit

Permalink
fix prompts and add the one for methods
Browse files Browse the repository at this point in the history
  • Loading branch information
miltondp authored Jul 11, 2024
1 parent 4a1ccd9 commit 58a46fe
Showing 1 changed file with 21 additions and 34 deletions.
55 changes: 21 additions & 34 deletions ci/ai-revision-prompts.yaml
Original file line number Diff line number Diff line change
@@ -1,43 +1,30 @@
prompts:
abstract: |
You are a scientist with copy-editing skills who will help in improving the
text of a manuscript. Revise the following abstract of this manuscript so
that it has a clear sentence structure and fits in a single paragraph. The
revision should follow a context-content-conclusion (C-C-C) scheme, as
follows: 1) The context portion communicates to the reader what gap the
paper will fill. The first sentence orients the reader by introducing the
broader field in which the manuscript's research is situated. Then, the
context is narrowed until it lands on the open question that the research
answers. A successful context section distinguishes the research's
contributions from the current state-of-the-art, communicating what is
missing in the current literature (i.e., the specific gap) and why that
matters (i.e. the connection between the specific gap and the broader
context). 2) The content portion (e.g. "here we") first describes the novel
method or approach that was used to fill the gap, then presents an executive
summary of results. 3) The conclusion portion interprets the results to
answer the question that was posed at the end of the context portion. There
may be a second part to the conclusion portion that highlights how this
conclusion moves the broader field forward (e.g. "broader significance").
You are a scientist with copy-editing skills who will help in improving the text of a manuscript. Revise the following abstract of this manuscript so that it has a clear sentence structure and fits in a single paragraph. The revision should follow a context-content-conclusion (C-C-C) scheme, as follows: 1) The context portion communicates to the reader what gap the paper will fill. The first sentence orients the reader by introducing the broader field in which the manuscript's research is situated. Then, the context is narrowed until it lands on the open question that the research answers. A successful context section distinguishes the research’s contributions from the current state-of-the-art, communicating what is missing in the current literature (i.e., the specific gap) and why that matters (i.e. the connection between the specific gap and the broader context). 2) The content portion (e.g. "here we") first describes the novel method or approach that was used to fill the gap, then presents an executive summary of results. 3) The conclusion portion interprets the results to answer the question that was posed at the end of the context portion. There may be a second part to the conclusion portion that highlights how this conclusion moves the broader field forward (e.g. "broader significance").
Input paragraph: {{ content }}
Revised paragraph:
introduction: |
You are a scientist with copy-editing skills tasked with refining the text
of a scientific manuscript. Your goal is to revise the following paragraph
from the Introduction section to enhance clarity, reduce jargon, and
maintain a scholarly tone. The revision should adhere to Markdown formatting
and follow a Context-Content-Conclusion (C-C-C) structure. This structure
begins by setting the stage with one or two sentences (Context), progresses
through what is known from the literature (Content), and concludes by
highlighting an aspect of the knowledge gap the manuscript addresses
(Conclusion). Your revision should: 1) preserve the original information as
much as possible, with minimal changes to the text, 2) ensure most
references to scientific articles are kept exactly as they appear in the
original text; these references are crucial for academic integrity and may
appear with the format "[@TYPE:ID]" such as "[@pmid:33931583;
@doi:10.1101/2021.10.21.21265225; @pmid:31036433]", and 4) the revised
paragraph must encapsulate the entire revision, following the C-C-C
structure, within a single, cohesive paragraph.
You are a scientist with copy-editing skills tasked with refining the text of a scientific manuscript. Your goal is to revise the following paragraph from the Introduction section to enhance clarity, reduce jargon, and maintain a scholarly tone. The revision should adhere to Markdown formatting and follow a Context-Content-Conclusion (C-C-C) structure. This structure begins by setting the stage with one or two sentences (Context), progresses through what is known from the literature (Content), and concludes by highlighting an aspect of the knowledge gap the manuscript addresses (Conclusion). Your revision should: 1) preserve the original information as much as possible, with minimal changes to the text, 2) ensure most references to scientific articles are kept exactly as they appear in the original text; these references are crucial for academic integrity and may appear with the format "[@TYPE:ID]" such as "[@pmid:33931583; @doi:10.1101/2021.10.21.21265225; @pmid:31036433]", and 4) the revised paragraph must encapsulate the entire revision, following the C-C-C structure, within a single, cohesive paragraph.
Input paragraph: {{ content }}
Revised paragraph:
methods: |
You are a scientist with copy-editing skills tasked with refining the text of a scientific manuscript. Your goal is to revise the following paragraph from the Methods section to enhance clarity, reduce jargon, maintain a scholarly tone, and adhere to Markdown formatting. Your revision should: 1) preserve the original information as much as possible, with minimal changes to the text, 2) preserve technical details such as mathematical expressions, 3) ensure that equations (which could be numbered) are preserved and correctly defined, 4) preserve references to numbered equations, and 5) ensure most references to scientific articles are kept exactly as they appear in the original text; these references are crucial for academic integrity and may appear with the format "[@TYPE:ID]" such as "[@pmid:33931583; @doi:10.1101/2021.10.21.21265225; @pmid:31036433]".
Input paragraph: {{ content }}
Revised paragraph:
default: |
Proofread the following paragraph that is part of a scientific manuscript.
Keep all Markdown formatting, citations to other articles, mathematical
expressions, and equations.
Input paragraph: {{ content }}
Proofread paragraph:

0 comments on commit 58a46fe

Please sign in to comment.