tutorials:scientific_writing
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
| tutorials:scientific_writing [2023/08/20 23:26] – created chkuo | tutorials:scientific_writing [2024/09/16 23:04] (current) – [Management software] chkuo | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Scientific Writing ====== | ====== Scientific Writing ====== | ||
| - | + | * Guidelines for scientific writing that Chih-Horng Kuo (chk@gate.sinica.edu.tw) developed for our group members. Suggestions are welcome. | |
| - | Guidelines for scientific writing that Chih-Horng Kuo (chk@gate.sinica.edu.tw) developed for our group members. Suggestions are welcome. | + | * Related information: |
| + | * [[tutorials: | ||
| + | * [[tutorials: | ||
| ===== General ===== | ===== General ===== | ||
| * Writing is possibly the most important, yet also the most challenging part, of our work | * Writing is possibly the most important, yet also the most challenging part, of our work | ||
| * Critical for documenting achievements | * Critical for documenting achievements | ||
| - | * Transferable skill | + | * Critically important for many other career paths other than academic research |
| * Start early | * Start early | ||
| * Know the deadline, or establish one by yourself | * Know the deadline, or establish one by yourself | ||
| Line 15: | Line 17: | ||
| * Good news: Yes, you can do it, just not so easy. See all the successful cases around you. | * Good news: Yes, you can do it, just not so easy. See all the successful cases around you. | ||
| * Talking to people helps (a lot) | * Talking to people helps (a lot) | ||
| - | |||
| - | ===== Files ===== | ||
| - | * Backup | ||
| - | * Establish an automatic backup plan; manual backup plans are not practical | ||
| - | * Mac: Time Machine | ||
| - | * Linux: rsync scripts | ||
| - | |||
| - | * Naming and version control | ||
| - | * File names | ||
| - | * Do: short and informative. Include information such as project id, keyword (e.g. manuscript, report, keyword of figure/ | ||
| - | * Avoid: long names that are difficult to read (e.g., full title of the manuscript) | ||
| - | * Avoid: short names that are not informative (e.g., manuscript.docx, | ||
| - | * Avoid: space or special characters | ||
| - | * Avoid: " | ||
| - | * Versioning | ||
| - | * Version number should be the last part of the file name; two digits should be sufficient | ||
| - | * Optional: Add initials if multiple people are involved in the project | ||
| - | * When in doubt, save as a new version | ||
| - | * Recommended: | ||
| - | * Benefits | ||
| - | * Write as much as possible without worrying if those parts will be kept in later versions | ||
| - | * Throw away as much as needed to make a good story; you can always go back to previous versions to retrieve the deleted materials | ||
| - | * Project progress report | ||
| - | * In the beginning of the document, include: | ||
| - | * Name (__who__ prepared this report?) | ||
| - | * Date (__when__ was it prepared?) | ||
| - | * Project id (__what__ is it about?) | ||
| - | * Directory of relevant files (on lab servers for people to get raw data files if needed) | ||
| - | * For long reports, prepare a short summary section | ||
| - | * Branching and merging | ||
| - | * When multiple people are involved, branches may be created for each person to work on a different part | ||
| - | * It is important that everyone agree with the leader on when and how to merge the branches | ||
| - | * Example | ||
| - | * For project " | ||
| - | * ABC then saved the file as " | ||
| - | * DEF creates " | ||
| - | * GHI creates " | ||
| - | * ABC being the project leader, should be responsible to set the deadline, collect the files, then merge and create " | ||
| - | * Figure/ | ||
| - | * Before finalizing the order, use names without fig/table number and with a keyword (e.g., " | ||
| - | * After finalizing the order, put all early versions into a separate folder (e.g., " | ||
| - | * If the order changed, put the previous versions into another separate folder (e.g., " | ||
| - | |||
| - | * Tracking changes | ||
| - | * For Word files: better to use the build-in function "Track Changes"; | ||
| - | * For Google Docs: all changes are automatically tracked. Manually name and download the major versions. | ||
| - | |||
| - | * Working with collaborators | ||
| - | * Discuss and setup a workflow | ||
| - | * Avoid emailing files as attachments; | ||
| - | * Pros and cons of setting up a file server vs. using a commercial service. | ||
| - | |||
| - | * File directory structure | ||
| - | * Make it easy to identify the parts that need to be included in backup | ||
| - | * Example for personal desktops/ | ||
| - | * Example for shared servers | ||
| - | |||
| - | |||
| ===== Abstract/ | ===== Abstract/ | ||
| Line 78: | Line 22: | ||
| ===== References ===== | ===== References ===== | ||
| + | |||
| + | ==== Management software ==== | ||
| * Zotero ([[https:// | * Zotero ([[https:// | ||
| - | * Zotero tips: [[https://twitter.com/ | + | * Zotero tips: [[https://x.com/ |
| * Several other options available (EndNote, Mendeley, etc), find one that works for you | * Several other options available (EndNote, Mendeley, etc), find one that works for you | ||
| * Academia Sinica has a site license for EndNote, the Life Sciences Library often have training courses on using it | * Academia Sinica has a site license for EndNote, the Life Sciences Library often have training courses on using it | ||
| - | |||
| * Download and account setup | * Download and account setup | ||
| * Syncing | * Syncing | ||
| - | |||
| * Importing references | * Importing references | ||
| * Zotero Connector: integration with browsers | * Zotero Connector: integration with browsers | ||
| * Add by DOI or other identifiers | * Add by DOI or other identifiers | ||
| * Manual entry | * Manual entry | ||
| - | |||
| * Library management | * Library management | ||
| * Folders and subfolders | * Folders and subfolders | ||
| Line 104: | Line 47: | ||
| * Is the page number missing? (particularly for online-only journals) | * Is the page number missing? (particularly for online-only journals) | ||
| * Add your own notes? | * Add your own notes? | ||
| - | |||
| * Style Manager | * Style Manager | ||
| * Remove the default ones that you do not need | * Remove the default ones that you do not need | ||
| * Add additional ones as needed | * Add additional ones as needed | ||
| - | |||
| * Integration with Word or Google Docs | * Integration with Word or Google Docs | ||
| * Communicate well with the collaborators; | * Communicate well with the collaborators; | ||
| Line 114: | Line 55: | ||
| * **<color blue> | * **<color blue> | ||
| - | * More | + | ====== |
| - | * So many papers! How do I remember them? | + | * So many papers! How do I remember them? |
| - | * A good filing system helps. More importantly, | + | * A good filing system helps. More importantly, |
| - | * Take notes (in Zotero) | + | * Take notes (in Zotero) |
| - | * Cite and discuss in your own manuscripts/ | + | * Cite and discuss in your own manuscripts/ |
| - | * Write a highlight (one sentence to multiple paragraphs), | + | * Write a highlight (one sentence to multiple paragraphs), |
| - | * Facebook group [[https:// | + | * Facebook group [[https:// |
| + | |||
| + | |||
| + | ====== Links ====== | ||
| + | * " | ||
| + | * [[https:// | ||
| + | * [[https:// | ||
tutorials/scientific_writing.1692545180.txt.gz · Last modified: 2023/08/20 23:26 by chkuo