Selaa lähdekoodia

Add research workflow guide

yila-research-6065 4 viikkoa sitten
vanhempi
sitoutus
7b87d088bd
1 muutettua tiedostoa jossa 77 lisäystä ja 2 poistoa
  1. 77 2
      README.md

+ 77 - 2
README.md

@@ -1,3 +1,78 @@
-# trustworthy-research-notebook
+# Keeping a Research Notebook That Your Future Self Can Trust
 
-Practical academic research workflow guide by Yila AI
+Most researchers keep notes. Far fewer keep notes they can rely on a year later. A typical notebook, whether paper or digital, is a mixture of half-sentences, unlabelled numbers, links that have rotted and summaries of papers that no longer match what the papers actually say. The cost becomes visible when you write: you find a striking claim in your notes, cannot remember where it came from, and either spend an hour hunting or, worse, cite it anyway. This guide describes how to keep a research notebook that stays trustworthy, and how an evidence-traceable research workbench such as [Yila](https://yila.ai) can make provenance automatic rather than a chore.
+
+## The core principle: every note has a source
+
+The single most important habit is simple: every note that records a fact, finding or quotation carries a precise pointer to its source. Not just the paper, but the location within it: page, section, table or figure. A note such as "attrition 23% in control arm (Smith 2021, Table 1, p. 4)" is useful indefinitely. A note such as "high attrition in Smith" is useful for a week.
+
+This principle applies equally to your own data. A note about an analysis result should point to the script, output file or notebook cell that produced it.
+
+## Separate observation from interpretation
+
+Notes mix what a source says with what you think about it. Keep the two visibly separate. One convention is to prefix interpretations with a marker such as "Me:" or to use a different colour. When you return to the note, you can see instantly which parts are the source's and which are yours.
+
+This matters most when your interpretation later changes. If your notes blend the two, you may find yourself attributing your own earlier opinion to an author who never held it.
+
+## Use consistent structure for literature notes
+
+For each paper you read seriously, use the same short template:
+
+- Full citation and link
+- Research question in one sentence
+- Design and sample
+- Key findings, each with a location
+- Limitations noted by the authors, with locations
+- Your own assessment, clearly marked
+- Links to related notes
+
+Consistency makes notes searchable and comparable. When you later need every study that used a particular measure, a consistent template makes the search fast.
+
+## Let tools record provenance for you
+
+Recording locations by hand is tedious, which is why many people skip it. Evidence-traceable tools reduce the burden. When you ask Yila a question about an uploaded paper, such as "What was the response rate and where is it reported?", the answer includes a link to the exact passage. Copying that answer into your notebook brings the provenance with it. Over months, this builds a notebook in which every factual note can be checked in a click.
+
+The habit to cultivate is to confirm each answer at its location before recording it. The tool locates; you verify and decide what goes into your notes.
+
+## Date everything
+
+Date every entry. Research evolves, papers are corrected, preprints become published versions with different numbers, and your own thinking changes. Dates let you reconstruct when you knew what, which is invaluable when writing a methods section, responding to reviewers or explaining a decision to a supervisor.
+
+For notes on preprints, record the version you read. If the published version differs, add a dated note rather than overwriting the original.
+
+## Record decisions and their reasons
+
+Some of the most valuable notes are records of decisions: why you chose one measure over another, why you excluded a dataset, why you changed a research question. These decisions are easy to forget and hard to justify later without a record. A short dated entry, "Chose scale X over Y because Y lacks validation in adolescents (see note on Jones 2019, p. 7)", saves hours when a reviewer asks.
+
+## Link notes to each other
+
+Ideas develop through connections. When a new paper relates to an earlier one, link the notes in both directions. When a finding supports or contradicts something you noted before, say so explicitly and link. Over time, the links form a map of your thinking that is far more useful than isolated summaries.
+
+## Review and prune regularly
+
+Set aside time, perhaps monthly, to review recent notes. Fill in missing locations while the source is still fresh, merge duplicates, mark notes that have been superseded and add links you missed. A notebook that is never reviewed degrades steadily; a little maintenance keeps it trustworthy.
+
+## Choose formats that last
+
+Notebooks outlive software. Prefer formats you can export and read without a specific application: plain text, Markdown or widely supported document formats. Keep source documents alongside notes where licensing allows, so links to locations do not break when a website changes. If you rely on a workbench to store documents and located answers, check that you can export them.
+
+## Write from your notes
+
+The payoff comes when you write. If every factual note carries a location, you can draft with confidence, citing precisely and quickly. When a co-author asks where a number came from, you can answer immediately. When a reviewer challenges a claim, you can check the source in seconds and respond calmly.
+
+Writing from trustworthy notes also reduces the temptation to rely on memory, which is where many citation errors begin.
+
+## A minimal starting routine
+
+If your current notebook is far from this ideal, start small:
+
+1. From today, add a location to every factual note.
+2. Mark your interpretations clearly.
+3. Date every entry.
+4. Once a month, spend an hour filling gaps in recent notes.
+
+Within a few months, the parts of your notebook you use most will be the parts you can trust.
+
+## Summary
+
+A trustworthy research notebook rests on a few habits: every note has a precise source, observation is separated from interpretation, literature notes follow a consistent template, entries are dated, decisions are recorded with reasons, notes are linked, and the notebook is reviewed regularly. Evidence-traceable tools make provenance nearly effortless. A workbench like [Yila](https://yila.ai) attaches a source location to every answer, so the notes you build are ones your future self can rely on.