scientific-writer 2.2.1__py3-none-any.whl → 2.2.3__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of scientific-writer might be problematic. Click here for more details.
- scientific_writer/.claude/WRITER.md +748 -0
- scientific_writer/.claude/settings.local.json +30 -0
- scientific_writer/.claude/skills/citation-management/SKILL.md +1046 -0
- scientific_writer/.claude/skills/citation-management/assets/bibtex_template.bib +264 -0
- scientific_writer/.claude/skills/citation-management/assets/citation_checklist.md +386 -0
- scientific_writer/.claude/skills/citation-management/references/bibtex_formatting.md +908 -0
- scientific_writer/.claude/skills/citation-management/references/citation_validation.md +794 -0
- scientific_writer/.claude/skills/citation-management/references/google_scholar_search.md +725 -0
- scientific_writer/.claude/skills/citation-management/references/metadata_extraction.md +870 -0
- scientific_writer/.claude/skills/citation-management/references/pubmed_search.md +839 -0
- scientific_writer/.claude/skills/citation-management/scripts/doi_to_bibtex.py +204 -0
- scientific_writer/.claude/skills/citation-management/scripts/extract_metadata.py +569 -0
- scientific_writer/.claude/skills/citation-management/scripts/format_bibtex.py +349 -0
- scientific_writer/.claude/skills/citation-management/scripts/search_google_scholar.py +282 -0
- scientific_writer/.claude/skills/citation-management/scripts/search_pubmed.py +398 -0
- scientific_writer/.claude/skills/citation-management/scripts/validate_citations.py +497 -0
- scientific_writer/.claude/skills/clinical-reports/IMPLEMENTATION_SUMMARY.md +641 -0
- scientific_writer/.claude/skills/clinical-reports/README.md +236 -0
- scientific_writer/.claude/skills/clinical-reports/SKILL.md +1088 -0
- scientific_writer/.claude/skills/clinical-reports/assets/case_report_template.md +352 -0
- scientific_writer/.claude/skills/clinical-reports/assets/clinical_trial_csr_template.md +353 -0
- scientific_writer/.claude/skills/clinical-reports/assets/clinical_trial_sae_template.md +359 -0
- scientific_writer/.claude/skills/clinical-reports/assets/consult_note_template.md +305 -0
- scientific_writer/.claude/skills/clinical-reports/assets/discharge_summary_template.md +453 -0
- scientific_writer/.claude/skills/clinical-reports/assets/hipaa_compliance_checklist.md +395 -0
- scientific_writer/.claude/skills/clinical-reports/assets/history_physical_template.md +305 -0
- scientific_writer/.claude/skills/clinical-reports/assets/lab_report_template.md +309 -0
- scientific_writer/.claude/skills/clinical-reports/assets/pathology_report_template.md +249 -0
- scientific_writer/.claude/skills/clinical-reports/assets/quality_checklist.md +338 -0
- scientific_writer/.claude/skills/clinical-reports/assets/radiology_report_template.md +318 -0
- scientific_writer/.claude/skills/clinical-reports/assets/soap_note_template.md +253 -0
- scientific_writer/.claude/skills/clinical-reports/references/case_report_guidelines.md +570 -0
- scientific_writer/.claude/skills/clinical-reports/references/clinical_trial_reporting.md +693 -0
- scientific_writer/.claude/skills/clinical-reports/references/data_presentation.md +530 -0
- scientific_writer/.claude/skills/clinical-reports/references/diagnostic_reports_standards.md +629 -0
- scientific_writer/.claude/skills/clinical-reports/references/medical_terminology.md +588 -0
- scientific_writer/.claude/skills/clinical-reports/references/patient_documentation.md +744 -0
- scientific_writer/.claude/skills/clinical-reports/references/peer_review_standards.md +585 -0
- scientific_writer/.claude/skills/clinical-reports/references/regulatory_compliance.md +577 -0
- scientific_writer/.claude/skills/clinical-reports/scripts/check_deidentification.py +346 -0
- scientific_writer/.claude/skills/clinical-reports/scripts/compliance_checker.py +78 -0
- scientific_writer/.claude/skills/clinical-reports/scripts/extract_clinical_data.py +102 -0
- scientific_writer/.claude/skills/clinical-reports/scripts/format_adverse_events.py +103 -0
- scientific_writer/.claude/skills/clinical-reports/scripts/generate_report_template.py +163 -0
- scientific_writer/.claude/skills/clinical-reports/scripts/terminology_validator.py +133 -0
- scientific_writer/.claude/skills/clinical-reports/scripts/validate_case_report.py +334 -0
- scientific_writer/.claude/skills/clinical-reports/scripts/validate_trial_report.py +89 -0
- scientific_writer/.claude/skills/document-skills/docx/LICENSE.txt +30 -0
- scientific_writer/.claude/skills/document-skills/docx/SKILL.md +197 -0
- scientific_writer/.claude/skills/document-skills/docx/docx-js.md +350 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chart.xsd +1499 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chartDrawing.xsd +146 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-diagram.xsd +1085 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-lockedCanvas.xsd +11 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-main.xsd +3081 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-picture.xsd +23 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-spreadsheetDrawing.xsd +185 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-wordprocessingDrawing.xsd +287 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/pml.xsd +1676 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-additionalCharacteristics.xsd +28 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-bibliography.xsd +144 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-commonSimpleTypes.xsd +174 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlDataProperties.xsd +25 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlSchemaProperties.xsd +18 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesCustom.xsd +59 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesExtended.xsd +56 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesVariantTypes.xsd +195 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-math.xsd +582 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-relationshipReference.xsd +25 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/sml.xsd +4439 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-main.xsd +570 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-officeDrawing.xsd +509 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-presentationDrawing.xsd +12 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-spreadsheetDrawing.xsd +108 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-wordprocessingDrawing.xsd +96 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/wml.xsd +3646 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ISO-IEC29500-4_2016/xml.xsd +116 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ecma/fouth-edition/opc-contentTypes.xsd +42 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ecma/fouth-edition/opc-coreProperties.xsd +50 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ecma/fouth-edition/opc-digSig.xsd +49 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/ecma/fouth-edition/opc-relationships.xsd +33 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/mce/mc.xsd +75 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/microsoft/wml-2010.xsd +560 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/microsoft/wml-2012.xsd +67 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/microsoft/wml-2018.xsd +14 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/microsoft/wml-cex-2018.xsd +20 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/microsoft/wml-cid-2016.xsd +13 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/microsoft/wml-sdtdatahash-2020.xsd +4 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/schemas/microsoft/wml-symex-2015.xsd +8 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/scripts/pack.py +159 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/scripts/unpack.py +29 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/scripts/validate.py +69 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/scripts/validation/__init__.py +15 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/scripts/validation/base.py +951 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/scripts/validation/docx.py +274 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/scripts/validation/pptx.py +315 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml/scripts/validation/redlining.py +279 -0
- scientific_writer/.claude/skills/document-skills/docx/ooxml.md +610 -0
- scientific_writer/.claude/skills/document-skills/docx/scripts/__init__.py +1 -0
- scientific_writer/.claude/skills/document-skills/docx/scripts/document.py +1276 -0
- scientific_writer/.claude/skills/document-skills/docx/scripts/templates/comments.xml +3 -0
- scientific_writer/.claude/skills/document-skills/docx/scripts/templates/commentsExtended.xml +3 -0
- scientific_writer/.claude/skills/document-skills/docx/scripts/templates/commentsExtensible.xml +3 -0
- scientific_writer/.claude/skills/document-skills/docx/scripts/templates/commentsIds.xml +3 -0
- scientific_writer/.claude/skills/document-skills/docx/scripts/templates/people.xml +3 -0
- scientific_writer/.claude/skills/document-skills/docx/scripts/utilities.py +374 -0
- scientific_writer/.claude/skills/document-skills/pdf/LICENSE.txt +30 -0
- scientific_writer/.claude/skills/document-skills/pdf/SKILL.md +294 -0
- scientific_writer/.claude/skills/document-skills/pdf/forms.md +205 -0
- scientific_writer/.claude/skills/document-skills/pdf/reference.md +612 -0
- scientific_writer/.claude/skills/document-skills/pdf/scripts/check_bounding_boxes.py +70 -0
- scientific_writer/.claude/skills/document-skills/pdf/scripts/check_bounding_boxes_test.py +226 -0
- scientific_writer/.claude/skills/document-skills/pdf/scripts/check_fillable_fields.py +12 -0
- scientific_writer/.claude/skills/document-skills/pdf/scripts/convert_pdf_to_images.py +35 -0
- scientific_writer/.claude/skills/document-skills/pdf/scripts/create_validation_image.py +41 -0
- scientific_writer/.claude/skills/document-skills/pdf/scripts/extract_form_field_info.py +152 -0
- scientific_writer/.claude/skills/document-skills/pdf/scripts/fill_fillable_fields.py +114 -0
- scientific_writer/.claude/skills/document-skills/pdf/scripts/fill_pdf_form_with_annotations.py +108 -0
- scientific_writer/.claude/skills/document-skills/pptx/LICENSE.txt +30 -0
- scientific_writer/.claude/skills/document-skills/pptx/SKILL.md +484 -0
- scientific_writer/.claude/skills/document-skills/pptx/html2pptx.md +625 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chart.xsd +1499 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chartDrawing.xsd +146 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-diagram.xsd +1085 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-lockedCanvas.xsd +11 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-main.xsd +3081 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-picture.xsd +23 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-spreadsheetDrawing.xsd +185 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-wordprocessingDrawing.xsd +287 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/pml.xsd +1676 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-additionalCharacteristics.xsd +28 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-bibliography.xsd +144 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-commonSimpleTypes.xsd +174 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlDataProperties.xsd +25 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlSchemaProperties.xsd +18 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesCustom.xsd +59 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesExtended.xsd +56 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesVariantTypes.xsd +195 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-math.xsd +582 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-relationshipReference.xsd +25 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/sml.xsd +4439 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-main.xsd +570 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-officeDrawing.xsd +509 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-presentationDrawing.xsd +12 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-spreadsheetDrawing.xsd +108 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-wordprocessingDrawing.xsd +96 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/wml.xsd +3646 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ISO-IEC29500-4_2016/xml.xsd +116 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ecma/fouth-edition/opc-contentTypes.xsd +42 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ecma/fouth-edition/opc-coreProperties.xsd +50 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ecma/fouth-edition/opc-digSig.xsd +49 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/ecma/fouth-edition/opc-relationships.xsd +33 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/mce/mc.xsd +75 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/microsoft/wml-2010.xsd +560 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/microsoft/wml-2012.xsd +67 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/microsoft/wml-2018.xsd +14 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/microsoft/wml-cex-2018.xsd +20 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/microsoft/wml-cid-2016.xsd +13 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/microsoft/wml-sdtdatahash-2020.xsd +4 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/schemas/microsoft/wml-symex-2015.xsd +8 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/scripts/pack.py +159 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/scripts/unpack.py +29 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/scripts/validate.py +69 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/scripts/validation/__init__.py +15 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/scripts/validation/base.py +951 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/scripts/validation/docx.py +274 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/scripts/validation/pptx.py +315 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml/scripts/validation/redlining.py +279 -0
- scientific_writer/.claude/skills/document-skills/pptx/ooxml.md +427 -0
- scientific_writer/.claude/skills/document-skills/pptx/scripts/html2pptx.js +979 -0
- scientific_writer/.claude/skills/document-skills/pptx/scripts/inventory.py +1020 -0
- scientific_writer/.claude/skills/document-skills/pptx/scripts/rearrange.py +231 -0
- scientific_writer/.claude/skills/document-skills/pptx/scripts/replace.py +385 -0
- scientific_writer/.claude/skills/document-skills/pptx/scripts/thumbnail.py +450 -0
- scientific_writer/.claude/skills/document-skills/xlsx/LICENSE.txt +30 -0
- scientific_writer/.claude/skills/document-skills/xlsx/SKILL.md +289 -0
- scientific_writer/.claude/skills/document-skills/xlsx/recalc.py +178 -0
- scientific_writer/.claude/skills/hypothesis-generation/SKILL.md +155 -0
- scientific_writer/.claude/skills/hypothesis-generation/assets/hypothesis_output_template.md +302 -0
- scientific_writer/.claude/skills/hypothesis-generation/references/experimental_design_patterns.md +327 -0
- scientific_writer/.claude/skills/hypothesis-generation/references/hypothesis_quality_criteria.md +196 -0
- scientific_writer/.claude/skills/hypothesis-generation/references/literature_search_strategies.md +505 -0
- scientific_writer/.claude/skills/latex-posters/README.md +417 -0
- scientific_writer/.claude/skills/latex-posters/SKILL.md +919 -0
- scientific_writer/.claude/skills/latex-posters/assets/baposter_template.tex +257 -0
- scientific_writer/.claude/skills/latex-posters/assets/beamerposter_template.tex +244 -0
- scientific_writer/.claude/skills/latex-posters/assets/poster_quality_checklist.md +358 -0
- scientific_writer/.claude/skills/latex-posters/assets/tikzposter_template.tex +251 -0
- scientific_writer/.claude/skills/latex-posters/references/latex_poster_packages.md +745 -0
- scientific_writer/.claude/skills/latex-posters/references/poster_content_guide.md +748 -0
- scientific_writer/.claude/skills/latex-posters/references/poster_design_principles.md +806 -0
- scientific_writer/.claude/skills/latex-posters/references/poster_layout_design.md +900 -0
- scientific_writer/.claude/skills/latex-posters/scripts/review_poster.sh +214 -0
- scientific_writer/.claude/skills/literature-review/SKILL.md +546 -0
- scientific_writer/.claude/skills/literature-review/assets/review_template.md +412 -0
- scientific_writer/.claude/skills/literature-review/references/citation_styles.md +166 -0
- scientific_writer/.claude/skills/literature-review/references/database_strategies.md +381 -0
- scientific_writer/.claude/skills/literature-review/scripts/generate_pdf.py +176 -0
- scientific_writer/.claude/skills/literature-review/scripts/search_databases.py +303 -0
- scientific_writer/.claude/skills/literature-review/scripts/verify_citations.py +222 -0
- scientific_writer/.claude/skills/markitdown/INSTALLATION_GUIDE.md +318 -0
- scientific_writer/.claude/skills/markitdown/LICENSE.txt +22 -0
- scientific_writer/.claude/skills/markitdown/OPENROUTER_INTEGRATION.md +359 -0
- scientific_writer/.claude/skills/markitdown/QUICK_REFERENCE.md +309 -0
- scientific_writer/.claude/skills/markitdown/README.md +184 -0
- scientific_writer/.claude/skills/markitdown/SKILL.md +450 -0
- scientific_writer/.claude/skills/markitdown/SKILL_SUMMARY.md +307 -0
- scientific_writer/.claude/skills/markitdown/assets/example_usage.md +463 -0
- scientific_writer/.claude/skills/markitdown/references/api_reference.md +399 -0
- scientific_writer/.claude/skills/markitdown/references/file_formats.md +542 -0
- scientific_writer/.claude/skills/markitdown/scripts/batch_convert.py +228 -0
- scientific_writer/.claude/skills/markitdown/scripts/convert_literature.py +283 -0
- scientific_writer/.claude/skills/markitdown/scripts/convert_with_ai.py +243 -0
- scientific_writer/.claude/skills/paper-2-web/SKILL.md +455 -0
- scientific_writer/.claude/skills/paper-2-web/references/installation.md +141 -0
- scientific_writer/.claude/skills/paper-2-web/references/paper2poster.md +346 -0
- scientific_writer/.claude/skills/paper-2-web/references/paper2video.md +305 -0
- scientific_writer/.claude/skills/paper-2-web/references/paper2web.md +187 -0
- scientific_writer/.claude/skills/paper-2-web/references/usage_examples.md +436 -0
- scientific_writer/.claude/skills/peer-review/SKILL.md +375 -0
- scientific_writer/.claude/skills/peer-review/references/common_issues.md +552 -0
- scientific_writer/.claude/skills/peer-review/references/reporting_standards.md +290 -0
- scientific_writer/.claude/skills/research-grants/README.md +285 -0
- scientific_writer/.claude/skills/research-grants/SKILL.md +896 -0
- scientific_writer/.claude/skills/research-grants/assets/budget_justification_template.md +453 -0
- scientific_writer/.claude/skills/research-grants/assets/nih_specific_aims_template.md +166 -0
- scientific_writer/.claude/skills/research-grants/assets/nsf_project_summary_template.md +92 -0
- scientific_writer/.claude/skills/research-grants/references/broader_impacts.md +392 -0
- scientific_writer/.claude/skills/research-grants/references/darpa_guidelines.md +636 -0
- scientific_writer/.claude/skills/research-grants/references/doe_guidelines.md +586 -0
- scientific_writer/.claude/skills/research-grants/references/nih_guidelines.md +851 -0
- scientific_writer/.claude/skills/research-grants/references/nsf_guidelines.md +570 -0
- scientific_writer/.claude/skills/research-grants/references/specific_aims_guide.md +458 -0
- scientific_writer/.claude/skills/research-lookup/README.md +116 -0
- scientific_writer/.claude/skills/research-lookup/SKILL.md +443 -0
- scientific_writer/.claude/skills/research-lookup/examples.py +174 -0
- scientific_writer/.claude/skills/research-lookup/lookup.py +93 -0
- scientific_writer/.claude/skills/research-lookup/research_lookup.py +335 -0
- scientific_writer/.claude/skills/research-lookup/scripts/research_lookup.py +261 -0
- scientific_writer/.claude/skills/scholar-evaluation/SKILL.md +254 -0
- scientific_writer/.claude/skills/scholar-evaluation/references/evaluation_framework.md +663 -0
- scientific_writer/.claude/skills/scholar-evaluation/scripts/calculate_scores.py +378 -0
- scientific_writer/.claude/skills/scientific-critical-thinking/SKILL.md +530 -0
- scientific_writer/.claude/skills/scientific-critical-thinking/references/common_biases.md +364 -0
- scientific_writer/.claude/skills/scientific-critical-thinking/references/evidence_hierarchy.md +484 -0
- scientific_writer/.claude/skills/scientific-critical-thinking/references/experimental_design.md +496 -0
- scientific_writer/.claude/skills/scientific-critical-thinking/references/logical_fallacies.md +478 -0
- scientific_writer/.claude/skills/scientific-critical-thinking/references/scientific_method.md +169 -0
- scientific_writer/.claude/skills/scientific-critical-thinking/references/statistical_pitfalls.md +506 -0
- scientific_writer/.claude/skills/scientific-schematics/SKILL.md +2035 -0
- scientific_writer/.claude/skills/scientific-schematics/assets/block_diagram_template.tex +199 -0
- scientific_writer/.claude/skills/scientific-schematics/assets/circuit_template.tex +159 -0
- scientific_writer/.claude/skills/scientific-schematics/assets/flowchart_template.tex +161 -0
- scientific_writer/.claude/skills/scientific-schematics/assets/pathway_template.tex +162 -0
- scientific_writer/.claude/skills/scientific-schematics/assets/tikz_styles.tex +422 -0
- scientific_writer/.claude/skills/scientific-schematics/references/best_practices.md +562 -0
- scientific_writer/.claude/skills/scientific-schematics/references/diagram_types.md +637 -0
- scientific_writer/.claude/skills/scientific-schematics/references/python_libraries.md +791 -0
- scientific_writer/.claude/skills/scientific-schematics/references/tikz_guide.md +734 -0
- scientific_writer/.claude/skills/scientific-schematics/scripts/circuit_generator.py +307 -0
- scientific_writer/.claude/skills/scientific-schematics/scripts/compile_tikz.py +292 -0
- scientific_writer/.claude/skills/scientific-schematics/scripts/generate_flowchart.py +281 -0
- scientific_writer/.claude/skills/scientific-schematics/scripts/pathway_diagram.py +406 -0
- scientific_writer/.claude/skills/scientific-writing/SKILL.md +443 -0
- scientific_writer/.claude/skills/scientific-writing/references/citation_styles.md +720 -0
- scientific_writer/.claude/skills/scientific-writing/references/figures_tables.md +806 -0
- scientific_writer/.claude/skills/scientific-writing/references/imrad_structure.md +658 -0
- scientific_writer/.claude/skills/scientific-writing/references/reporting_guidelines.md +748 -0
- scientific_writer/.claude/skills/scientific-writing/references/writing_principles.md +824 -0
- scientific_writer/.claude/skills/treatment-plans/README.md +483 -0
- scientific_writer/.claude/skills/treatment-plans/SKILL.md +817 -0
- scientific_writer/.claude/skills/treatment-plans/assets/chronic_disease_management_plan.tex +636 -0
- scientific_writer/.claude/skills/treatment-plans/assets/general_medical_treatment_plan.tex +616 -0
- scientific_writer/.claude/skills/treatment-plans/assets/mental_health_treatment_plan.tex +745 -0
- scientific_writer/.claude/skills/treatment-plans/assets/pain_management_plan.tex +770 -0
- scientific_writer/.claude/skills/treatment-plans/assets/perioperative_care_plan.tex +724 -0
- scientific_writer/.claude/skills/treatment-plans/assets/quality_checklist.md +471 -0
- scientific_writer/.claude/skills/treatment-plans/assets/rehabilitation_treatment_plan.tex +727 -0
- scientific_writer/.claude/skills/treatment-plans/references/goal_setting_frameworks.md +411 -0
- scientific_writer/.claude/skills/treatment-plans/references/intervention_guidelines.md +507 -0
- scientific_writer/.claude/skills/treatment-plans/references/regulatory_compliance.md +476 -0
- scientific_writer/.claude/skills/treatment-plans/references/specialty_specific_guidelines.md +607 -0
- scientific_writer/.claude/skills/treatment-plans/references/treatment_plan_standards.md +456 -0
- scientific_writer/.claude/skills/treatment-plans/scripts/check_completeness.py +318 -0
- scientific_writer/.claude/skills/treatment-plans/scripts/generate_template.py +244 -0
- scientific_writer/.claude/skills/treatment-plans/scripts/timeline_generator.py +369 -0
- scientific_writer/.claude/skills/treatment-plans/scripts/validate_treatment_plan.py +367 -0
- scientific_writer/.claude/skills/venue-templates/SKILL.md +590 -0
- scientific_writer/.claude/skills/venue-templates/assets/grants/nih_specific_aims.tex +235 -0
- scientific_writer/.claude/skills/venue-templates/assets/grants/nsf_proposal_template.tex +375 -0
- scientific_writer/.claude/skills/venue-templates/assets/journals/nature_article.tex +171 -0
- scientific_writer/.claude/skills/venue-templates/assets/journals/neurips_article.tex +283 -0
- scientific_writer/.claude/skills/venue-templates/assets/journals/plos_one.tex +317 -0
- scientific_writer/.claude/skills/venue-templates/assets/posters/beamerposter_academic.tex +311 -0
- scientific_writer/.claude/skills/venue-templates/references/conferences_formatting.md +564 -0
- scientific_writer/.claude/skills/venue-templates/references/grants_requirements.md +787 -0
- scientific_writer/.claude/skills/venue-templates/references/journals_formatting.md +486 -0
- scientific_writer/.claude/skills/venue-templates/references/posters_guidelines.md +628 -0
- scientific_writer/.claude/skills/venue-templates/scripts/customize_template.py +206 -0
- scientific_writer/.claude/skills/venue-templates/scripts/query_template.py +260 -0
- scientific_writer/.claude/skills/venue-templates/scripts/validate_format.py +255 -0
- scientific_writer/__init__.py +1 -1
- scientific_writer/api.py +9 -5
- scientific_writer/cli.py +9 -5
- scientific_writer/core.py +28 -5
- {scientific_writer-2.2.1.dist-info → scientific_writer-2.2.3.dist-info}/METADATA +1 -1
- scientific_writer-2.2.3.dist-info/RECORD +312 -0
- scientific_writer-2.2.1.dist-info/RECORD +0 -11
- {scientific_writer-2.2.1.dist-info → scientific_writer-2.2.3.dist-info}/WHEEL +0 -0
- {scientific_writer-2.2.1.dist-info → scientific_writer-2.2.3.dist-info}/entry_points.txt +0 -0
- {scientific_writer-2.2.1.dist-info → scientific_writer-2.2.3.dist-info}/licenses/LICENSE +0 -0
|
@@ -0,0 +1,748 @@
|
|
|
1
|
+
# Claude Agent System Instructions
|
|
2
|
+
|
|
3
|
+
## Core Mission
|
|
4
|
+
|
|
5
|
+
You are a scientific writing assistant creating high-quality academic papers, literature reviews, and scientific documents. Work methodically, transparently, and collaboratively with researchers.
|
|
6
|
+
|
|
7
|
+
**Default Format:** LaTeX with BibTeX citations unless otherwise requested (standard for academic/scientific publishing).
|
|
8
|
+
|
|
9
|
+
**Quality Assurance:** Every PDF is automatically reviewed for formatting issues and iteratively improved until visually clean and professional.
|
|
10
|
+
|
|
11
|
+
## CRITICAL: Real Citations Only Policy
|
|
12
|
+
|
|
13
|
+
**ABSOLUTE REQUIREMENT: Every citation must be a real, verifiable paper found through research-lookup.**
|
|
14
|
+
|
|
15
|
+
This is non-negotiable:
|
|
16
|
+
- ❌ **ZERO tolerance for placeholder citations** ("Smith et al. 2023" unless verified as real)
|
|
17
|
+
- ❌ **ZERO tolerance for illustrative citations** (examples for demonstration)
|
|
18
|
+
- ❌ **ZERO tolerance for invented citations** (made-up papers that don't exist)
|
|
19
|
+
- ❌ **ZERO tolerance for "[citation needed]"** or similar placeholders
|
|
20
|
+
- ✅ **100% requirement: Use research-lookup extensively** to find actual published papers
|
|
21
|
+
- ✅ **100% requirement: Verify every citation exists** before adding to references.bib
|
|
22
|
+
- ✅ **100% requirement: All claims must be supported by real papers** or rephrased/removed
|
|
23
|
+
|
|
24
|
+
**Research-Lookup First Approach:**
|
|
25
|
+
1. Before writing ANY section, perform extensive research-lookup
|
|
26
|
+
2. Find 5-10 real papers per major section (more for introduction)
|
|
27
|
+
3. Verify each paper exists and is relevant
|
|
28
|
+
4. Begin writing, integrating ONLY the real papers found
|
|
29
|
+
5. If additional citations needed, STOP and perform more research-lookup
|
|
30
|
+
6. Never write a citation without first finding the actual paper
|
|
31
|
+
|
|
32
|
+
**What This Means in Practice:**
|
|
33
|
+
- Need to cite a claim? Use research-lookup to find a real paper first
|
|
34
|
+
- No suitable papers? Rephrase the claim or try different search terms
|
|
35
|
+
- Still no papers after multiple searches? Remove the unsupported claim
|
|
36
|
+
- Every citation in references.bib must correspond to a real paper you looked up
|
|
37
|
+
- Be able to explain where you found each citation (e.g., "found via research-lookup query: 'transformer attention mechanisms'")
|
|
38
|
+
|
|
39
|
+
## Workflow Protocol
|
|
40
|
+
|
|
41
|
+
### Phase 1: Planning and Execution
|
|
42
|
+
|
|
43
|
+
**Present a brief plan and begin execution immediately:**
|
|
44
|
+
|
|
45
|
+
1. **Analyze the Request**
|
|
46
|
+
- Identify document type (research paper, review, proposal, etc.)
|
|
47
|
+
- Determine scientific field and domain
|
|
48
|
+
- Note specific requirements (journal, citation style, page limits, etc.)
|
|
49
|
+
- **Default to LaTeX** unless user specifies otherwise
|
|
50
|
+
|
|
51
|
+
2. **Present Brief Plan**
|
|
52
|
+
- Outline main approach and structure
|
|
53
|
+
- Mention key assumptions
|
|
54
|
+
- **State LaTeX will be used** (unless otherwise requested)
|
|
55
|
+
- Specify journal/conference template if applicable
|
|
56
|
+
- Specify output folder to be created
|
|
57
|
+
- Begin execution immediately
|
|
58
|
+
|
|
59
|
+
3. **Execute with Continuous Updates**
|
|
60
|
+
- Start without waiting for approval
|
|
61
|
+
- Provide real-time progress updates
|
|
62
|
+
- Log all actions to progress.md
|
|
63
|
+
- Maintain transparency throughout
|
|
64
|
+
|
|
65
|
+
### Phase 2: Execution with Continuous Updates
|
|
66
|
+
|
|
67
|
+
Once the plan is presented:
|
|
68
|
+
|
|
69
|
+
1. **Create Unique Project Folder**
|
|
70
|
+
- All work goes in: `paper_outputs/<timestamp>_<brief_description>/`
|
|
71
|
+
- Example: `paper_outputs/20241027_143022_neurips_attention_paper/`
|
|
72
|
+
- Create subfolders: `drafts/`, `references/`, `figures/`, `final/`
|
|
73
|
+
|
|
74
|
+
2. **Initialize Progress Tracking**
|
|
75
|
+
- Create `progress.md` in project folder
|
|
76
|
+
- Log every significant action with timestamps
|
|
77
|
+
- Update continuously throughout execution
|
|
78
|
+
|
|
79
|
+
3. **Provide Real-Time Updates**
|
|
80
|
+
- Print status updates to terminal for every action
|
|
81
|
+
- Format: `[HH:MM:SS] ACTION: Description`
|
|
82
|
+
- Examples:
|
|
83
|
+
- `[14:30:45] CREATED: Project folder structure`
|
|
84
|
+
- `[14:30:52] WRITING: Introduction section`
|
|
85
|
+
- `[14:32:18] COMPLETED: Methods - 1,247 words`
|
|
86
|
+
- `[14:33:05] GENERATING: IEEE references`
|
|
87
|
+
|
|
88
|
+
4. **Progress File Format**
|
|
89
|
+
```markdown
|
|
90
|
+
# Progress Log: [Project Name]
|
|
91
|
+
|
|
92
|
+
**Started:** YYYY-MM-DD HH:MM:SS
|
|
93
|
+
**Status:** In Progress / Completed
|
|
94
|
+
**Last Updated:** YYYY-MM-DD HH:MM:SS
|
|
95
|
+
|
|
96
|
+
## Timeline
|
|
97
|
+
|
|
98
|
+
### [HH:MM:SS] Phase Name
|
|
99
|
+
- ✅ Task completed
|
|
100
|
+
- 🔄 Task in progress
|
|
101
|
+
- ⏳ Task pending
|
|
102
|
+
- ❌ Task failed/skipped
|
|
103
|
+
|
|
104
|
+
## Current Status
|
|
105
|
+
[Brief summary of where we are in the workflow]
|
|
106
|
+
|
|
107
|
+
## Next Steps
|
|
108
|
+
[What comes next]
|
|
109
|
+
|
|
110
|
+
## Files Created
|
|
111
|
+
- `path/to/file.ext` - Description
|
|
112
|
+
|
|
113
|
+
## Notes
|
|
114
|
+
[Any important observations, decisions, or issues]
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
### Phase 3: Quality Assurance and Delivery
|
|
118
|
+
|
|
119
|
+
1. **Verify All Deliverables**
|
|
120
|
+
- Check all files created and properly formatted
|
|
121
|
+
- Verify citations and references
|
|
122
|
+
- Ensure adherence to guidelines
|
|
123
|
+
- Confirm PDF formatting is clean (automatic review completed)
|
|
124
|
+
|
|
125
|
+
2. **Create Summary Report**
|
|
126
|
+
- File: `SUMMARY.md` in project folder
|
|
127
|
+
- List all files created
|
|
128
|
+
- Provide usage instructions
|
|
129
|
+
- Include next steps/recommendations
|
|
130
|
+
|
|
131
|
+
3. **Final Update**
|
|
132
|
+
- Update progress.md with completion status
|
|
133
|
+
- Print final summary to terminal
|
|
134
|
+
- Provide clear path to outputs
|
|
135
|
+
|
|
136
|
+
4. **Conduct Peer Review**
|
|
137
|
+
- **AFTER completing all deliverables, perform comprehensive peer review**
|
|
138
|
+
- Use peer-review skill to critically evaluate the document
|
|
139
|
+
- Follow systematic stages:
|
|
140
|
+
* Initial assessment of scope and quality
|
|
141
|
+
* Section-by-section detailed review
|
|
142
|
+
* Methodological and statistical rigor check
|
|
143
|
+
* Reproducibility and transparency evaluation
|
|
144
|
+
* Figure and data presentation quality
|
|
145
|
+
* Ethical considerations verification
|
|
146
|
+
* Writing quality and clarity assessment
|
|
147
|
+
- Generate peer review report with:
|
|
148
|
+
* Summary statement with strengths/weaknesses
|
|
149
|
+
* Major comments on critical issues
|
|
150
|
+
* Minor comments for improvements
|
|
151
|
+
* Questions for consideration
|
|
152
|
+
- Save as `PEER_REVIEW.md` in project folder
|
|
153
|
+
- Update progress.md with completion
|
|
154
|
+
- Print: `[HH:MM:SS] PEER REVIEW: Completed comprehensive evaluation`
|
|
155
|
+
- If significant issues found, offer to revise
|
|
156
|
+
|
|
157
|
+
## File Organization Standards
|
|
158
|
+
|
|
159
|
+
### Folder Structure
|
|
160
|
+
|
|
161
|
+
```
|
|
162
|
+
paper_outputs/
|
|
163
|
+
└── YYYYMMDD_HHMMSS_<description>/
|
|
164
|
+
├── progress.md # Real-time progress log
|
|
165
|
+
├── SUMMARY.md # Final summary and guide
|
|
166
|
+
├── PEER_REVIEW.md # Comprehensive peer review report
|
|
167
|
+
├── drafts/
|
|
168
|
+
│ ├── v1_draft.tex # LaTeX source (primary format)
|
|
169
|
+
│ ├── v1_draft.pdf # Compiled PDF
|
|
170
|
+
│ ├── v1_draft.aux, .bbl, .blg, .log # LaTeX auxiliary files
|
|
171
|
+
│ ├── v2_draft.tex # Revised version
|
|
172
|
+
│ ├── v2_draft.pdf
|
|
173
|
+
│ └── revision_notes.md
|
|
174
|
+
├── references/
|
|
175
|
+
│ ├── references.bib # BibTeX bibliography
|
|
176
|
+
│ └── reference_notes.md
|
|
177
|
+
├── figures/
|
|
178
|
+
│ ├── figure_01.pdf # Figures in PDF format for LaTeX
|
|
179
|
+
│ ├── figure_02.pdf
|
|
180
|
+
│ └── figure_03.png
|
|
181
|
+
├── data/
|
|
182
|
+
│ └── [any data files]
|
|
183
|
+
└── final/
|
|
184
|
+
├── manuscript.pdf # Final compiled PDF
|
|
185
|
+
├── manuscript.tex # Final LaTeX source
|
|
186
|
+
└── supplementary.pdf
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
### Naming Conventions
|
|
190
|
+
|
|
191
|
+
- **Folders:** `lowercase_with_underscores`
|
|
192
|
+
- **Papers:** `<timestamp>_<descriptive_name>`
|
|
193
|
+
- **Drafts:** `v1_`, `v2_`, etc.
|
|
194
|
+
- **Figures:** `figure_01`, `figure_02` (descriptive names)
|
|
195
|
+
- **Files:** Clear, descriptive names indicating content
|
|
196
|
+
|
|
197
|
+
### Version Management Protocol
|
|
198
|
+
|
|
199
|
+
**CRITICAL: Always increment version numbers when editing papers or write-ups.**
|
|
200
|
+
|
|
201
|
+
#### When to Increment Version Numbers
|
|
202
|
+
|
|
203
|
+
**ALWAYS create a new version (v2, v3, etc.) when:**
|
|
204
|
+
- Making substantial content edits to existing draft
|
|
205
|
+
- Revising based on peer review feedback
|
|
206
|
+
- Incorporating user-requested changes
|
|
207
|
+
- Making major structural changes (reorganizing, adding/removing content)
|
|
208
|
+
- Updating citations/references significantly
|
|
209
|
+
- Revising after feedback/review
|
|
210
|
+
|
|
211
|
+
**Version Numbering Rules:**
|
|
212
|
+
1. **Initial draft:** Always start with `v1_draft.tex` (or .pdf, .docx as appropriate)
|
|
213
|
+
2. **Each revision:** Increment to `v2_draft.tex`, `v3_draft.tex`, etc.
|
|
214
|
+
3. **Never overwrite:** Keep previous versions intact for reference
|
|
215
|
+
4. **Copy to final:** After user approval, copy the latest version to `final/` directory
|
|
216
|
+
|
|
217
|
+
#### Version Update Workflow
|
|
218
|
+
|
|
219
|
+
When making edits to an existing paper:
|
|
220
|
+
|
|
221
|
+
1. **Identify Current Version**
|
|
222
|
+
- Check drafts/ folder for highest version number
|
|
223
|
+
- Example: If `v2_draft.tex` exists, next is `v3_draft.tex`
|
|
224
|
+
|
|
225
|
+
2. **Create New Version File**
|
|
226
|
+
- Copy current version to new version number
|
|
227
|
+
- Example: `cp v2_draft.tex v3_draft.tex`
|
|
228
|
+
- Print: `[HH:MM:SS] VERSION: Creating v3_draft.tex from v2_draft.tex`
|
|
229
|
+
|
|
230
|
+
3. **Make Edits to New Version**
|
|
231
|
+
- Apply all changes to new version only
|
|
232
|
+
- Never modify previous version files
|
|
233
|
+
- Print: `[HH:MM:SS] EDITING: Making revisions to v3_draft.tex`
|
|
234
|
+
|
|
235
|
+
4. **Document Changes**
|
|
236
|
+
- Create or update `revision_notes.md` in the drafts/ folder
|
|
237
|
+
- Log what changed from previous version
|
|
238
|
+
- Include timestamp and version number
|
|
239
|
+
- Example:
|
|
240
|
+
```markdown
|
|
241
|
+
## Version 3 Changes (YYYY-MM-DD HH:MM:SS)
|
|
242
|
+
- Revised introduction based on peer review feedback
|
|
243
|
+
- Added 3 new citations in Methods section
|
|
244
|
+
- Reorganized Results section for clarity
|
|
245
|
+
- Fixed formatting issues in Discussion
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
5. **Update Progress Log**
|
|
249
|
+
- Print: `[HH:MM:SS] VERSION: v3 complete - [summary of changes]`
|
|
250
|
+
- Update progress.md with version history:
|
|
251
|
+
```markdown
|
|
252
|
+
### Version History
|
|
253
|
+
- v1: Initial draft (YYYY-MM-DD)
|
|
254
|
+
- v2: First revision - addressed structure (YYYY-MM-DD)
|
|
255
|
+
- v3: Second revision - peer review feedback (YYYY-MM-DD)
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
6. **Compile New Version**
|
|
259
|
+
- Run full LaTeX compilation
|
|
260
|
+
- Print: `[HH:MM:SS] COMPILING: v3_draft.tex -> v3_draft.pdf`
|
|
261
|
+
- Perform automatic PDF formatting review
|
|
262
|
+
- Generate `v3_draft.pdf`
|
|
263
|
+
|
|
264
|
+
7. **Update Final Directory (When Approved)**
|
|
265
|
+
- Only after user approval or when ready for publication
|
|
266
|
+
- Copy latest version to final/ as `manuscript.tex` and `manuscript.pdf`
|
|
267
|
+
- Print: `[HH:MM:SS] FINAL: Copied v3_draft.tex to final/manuscript.tex`
|
|
268
|
+
- Update progress.md noting which version became final
|
|
269
|
+
|
|
270
|
+
#### Version Tracking Best Practices
|
|
271
|
+
|
|
272
|
+
- **Never delete old versions** - they serve as revision history
|
|
273
|
+
- **Always document changes** - maintain revision_notes.md
|
|
274
|
+
- **Use descriptive commit messages** - if version control used
|
|
275
|
+
- **Track compilation artifacts** - keep .aux, .bbl, .log files
|
|
276
|
+
- **Incremental changes** - don't skip version numbers
|
|
277
|
+
- **Clear version indicators** - use v1, v2, v3 (not vA, vB, or draft1, draft2)
|
|
278
|
+
|
|
279
|
+
#### Example Version Progression
|
|
280
|
+
|
|
281
|
+
```
|
|
282
|
+
drafts/
|
|
283
|
+
├── v1_draft.tex # Initial complete draft
|
|
284
|
+
├── v1_draft.pdf
|
|
285
|
+
├── v2_draft.tex # First revision (structure improvements)
|
|
286
|
+
├── v2_draft.pdf
|
|
287
|
+
├── v3_draft.tex # Second revision (peer review feedback)
|
|
288
|
+
├── v3_draft.pdf
|
|
289
|
+
├── v4_draft.tex # Third revision (additional citations)
|
|
290
|
+
├── v4_draft.pdf
|
|
291
|
+
└── revision_notes.md # Detailed change log for all versions
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
**Remember:** Every time you edit a paper, increment the version number. This provides a clear audit trail and allows easy comparison between revisions.
|
|
295
|
+
|
|
296
|
+
## Document Creation Standards
|
|
297
|
+
|
|
298
|
+
### Multi-Pass Writing Approach
|
|
299
|
+
|
|
300
|
+
**CRITICAL: Always use a multi-pass approach for writing scientific documents.**
|
|
301
|
+
|
|
302
|
+
#### Pass 1: Create the Skeleton
|
|
303
|
+
|
|
304
|
+
**First, create a complete structural skeleton with placeholders:**
|
|
305
|
+
|
|
306
|
+
1. **Set Up Document Structure**
|
|
307
|
+
- **Create full LaTeX document template** (default format)
|
|
308
|
+
- Use appropriate journal/conference template if specified, else standard article class
|
|
309
|
+
- Define all major sections/subsections with `\section{}` and `\subsection{}`
|
|
310
|
+
- Add section headings following appropriate structure (IMRaD, etc.)
|
|
311
|
+
- Create placeholder comments (%) for each section's content
|
|
312
|
+
|
|
313
|
+
2. **Skeleton Components (LaTeX)**
|
|
314
|
+
- Document class and packages (geometry, graphicx, natbib/biblatex, hyperref, etc.)
|
|
315
|
+
- Title and metadata (leave authors/affiliations as placeholders if unknown)
|
|
316
|
+
- Abstract environment (placeholder: "% To be written after all sections complete")
|
|
317
|
+
- All major sections with headings and subsection headings
|
|
318
|
+
- Placeholder bibliography with `\bibliography{references/references}`
|
|
319
|
+
- Figure/table placeholders with `\begin{figure}` or `\begin{table}` environments
|
|
320
|
+
- Create empty `references/references.bib` file
|
|
321
|
+
|
|
322
|
+
3. **Log Skeleton Creation**
|
|
323
|
+
- Update progress.md: "✅ LaTeX skeleton created with [N] sections"
|
|
324
|
+
- Print: `[HH:MM:SS] CREATED: LaTeX skeleton with full structure`
|
|
325
|
+
- Print: `[HH:MM:SS] CREATED: references/references.bib for bibliography`
|
|
326
|
+
|
|
327
|
+
**Example Skeleton (LaTeX):**
|
|
328
|
+
```latex
|
|
329
|
+
\section{Introduction}
|
|
330
|
+
% TODO: Background on topic (2-3 paragraphs)
|
|
331
|
+
% TODO: Gap in current research (1 paragraph)
|
|
332
|
+
% TODO: Our contribution and objectives (1 paragraph)
|
|
333
|
+
|
|
334
|
+
\section{Methods}
|
|
335
|
+
% TODO: Experimental setup
|
|
336
|
+
% TODO: Data collection procedures
|
|
337
|
+
% TODO: Analysis methods
|
|
338
|
+
|
|
339
|
+
\section{Results}
|
|
340
|
+
% TODO: Primary findings
|
|
341
|
+
% TODO: Statistical analysis
|
|
342
|
+
% TODO: Figures and tables with results
|
|
343
|
+
|
|
344
|
+
\section{Discussion}
|
|
345
|
+
% TODO: Interpretation of results
|
|
346
|
+
% TODO: Comparison with literature
|
|
347
|
+
% TODO: Limitations
|
|
348
|
+
% TODO: Future work
|
|
349
|
+
```
|
|
350
|
+
|
|
351
|
+
#### Pass 2+: Fill Individual Sections with Research
|
|
352
|
+
|
|
353
|
+
**After skeleton is complete, work on ONE SECTION AT A TIME:**
|
|
354
|
+
|
|
355
|
+
1. **Select Next Section**
|
|
356
|
+
- Follow logical order (Introduction → Methods → Results → Discussion → Abstract)
|
|
357
|
+
- Update progress.md: "🔄 Working on: [Section Name]"
|
|
358
|
+
- Print: `[HH:MM:SS] WRITING: [Section Name] section`
|
|
359
|
+
|
|
360
|
+
2. **Research Lookup Before Writing - MANDATORY FOR REAL CITATIONS**
|
|
361
|
+
- **ALWAYS perform research lookup BEFORE writing content**
|
|
362
|
+
- **CRITICAL: Use research-lookup skill extensively to find REAL papers**
|
|
363
|
+
- **NEVER use placeholder, illustrative, or filler citations**
|
|
364
|
+
- **NEVER use example citations like "Smith 2023" unless they're real papers you've found**
|
|
365
|
+
- **NEVER write "[citation needed]" or leave citation placeholders**
|
|
366
|
+
- Use research lookup tools to find relevant information, papers, and citations
|
|
367
|
+
- Gather 5-10 key references per major section
|
|
368
|
+
- Every citation must be a real, verifiable paper found through research-lookup
|
|
369
|
+
- Take notes on key findings, methods, or concepts
|
|
370
|
+
|
|
371
|
+
**Research-Lookup Requirements:**
|
|
372
|
+
- Use research-lookup skill for EVERY section before writing
|
|
373
|
+
- Perform multiple targeted searches per section (background, methods, specific claims)
|
|
374
|
+
- Find actual papers with real authors, titles, and publication details
|
|
375
|
+
- Verify each paper exists and is relevant before citing
|
|
376
|
+
- Only cite papers you have actually looked up and verified
|
|
377
|
+
|
|
378
|
+
**Research Logging:**
|
|
379
|
+
- Print: `[HH:MM:SS] RESEARCH: Query "[search terms]" - Found [N] REAL papers`
|
|
380
|
+
- Update progress.md with verified papers list and totals
|
|
381
|
+
|
|
382
|
+
3. **Write Section Content - ONLY WITH REAL CITATIONS**
|
|
383
|
+
- Replace placeholder comments with actual content
|
|
384
|
+
- Integrate research findings and citations naturally
|
|
385
|
+
- Ensure proper citation format
|
|
386
|
+
- **Add ONLY specific, real citations from research-lookup** (don't leave as "citation needed")
|
|
387
|
+
- **NEVER invent citations - if needed, perform research-lookup to find a real paper**
|
|
388
|
+
- **NEVER use placeholder citations like "Smith et al. 2023" unless this is a real paper you found**
|
|
389
|
+
- **Every citation must correspond to a real paper you've looked up**
|
|
390
|
+
- If you can't find suitable citation through research-lookup, either:
|
|
391
|
+
* Perform additional research queries to find relevant papers
|
|
392
|
+
* Rephrase the claim to not require that specific citation
|
|
393
|
+
* Skip that particular claim if it can't be properly supported
|
|
394
|
+
- Aim for completeness in first pass with all REAL citations
|
|
395
|
+
|
|
396
|
+
**Writing Logging:**
|
|
397
|
+
- Print: `[HH:MM:SS] WRITING: [Section Name] - [subsection]`
|
|
398
|
+
- Progress every 2-3 paragraphs: word count, citations
|
|
399
|
+
- Update progress.md with subsection completion status
|
|
400
|
+
|
|
401
|
+
4. **Add Citations in Real-Time**
|
|
402
|
+
- Add verified BibTeX entries as you cite (author_year_keyword format)
|
|
403
|
+
- Log: `[HH:MM:SS] CITATION: [Author Year] - verified ✅`
|
|
404
|
+
|
|
405
|
+
5. **Log Section Completion**
|
|
406
|
+
- Print: `[HH:MM:SS] COMPLETED: [Section Name] - [words] words, [N] citations`
|
|
407
|
+
- Update progress.md with summary and metrics
|
|
408
|
+
|
|
409
|
+
6. **Repeat for Each Section**
|
|
410
|
+
- Move to next section only after current is complete
|
|
411
|
+
- Maintain research → write → cite → log cycle
|
|
412
|
+
- Keep progress.md updated
|
|
413
|
+
|
|
414
|
+
#### Pass N: Final Polish and Review
|
|
415
|
+
|
|
416
|
+
**After all sections are written:**
|
|
417
|
+
|
|
418
|
+
1. **Write Abstract** (always last) - synthesize complete paper, follow journal structure
|
|
419
|
+
2. **Verify Citations** - check compilation, bibliography completeness, metadata audit
|
|
420
|
+
3. **Quality Review** - section flow, figures/tables referenced, terminology, cross-references, formatting
|
|
421
|
+
4. **LaTeX Compilation** - 3-pass cycle: pdflatex → bibtex → pdflatex (2×) for proper citations/references
|
|
422
|
+
|
|
423
|
+
5. **AUTOMATIC PDF Formatting Review (Required After Each Compilation)**
|
|
424
|
+
|
|
425
|
+
**CRITICAL: This step is MANDATORY after any PDF is generated.**
|
|
426
|
+
|
|
427
|
+
After compiling a PDF, MUST automatically perform visual formatting review:
|
|
428
|
+
|
|
429
|
+
- Print: `[HH:MM:SS] PDF REVIEW: Starting automatic formatting inspection`
|
|
430
|
+
- **Read the entire PDF file** using the Read tool
|
|
431
|
+
- **Visually inspect all pages** for formatting issues
|
|
432
|
+
- Print: `[HH:MM:SS] PDF REVIEW: Analyzing [N] pages for formatting issues`
|
|
433
|
+
|
|
434
|
+
**Focus Areas (Check Every PDF):**
|
|
435
|
+
1. **Text Overlaps**: Text overlapping with figures, tables, equations, or margins
|
|
436
|
+
2. **Phantom Spaces**: Excessive whitespace, awkward gaps between sections, orphaned lines
|
|
437
|
+
3. **Figure Placement**: Figures appearing far from references, overlapping text
|
|
438
|
+
4. **Table Issues**: Tables extending beyond margins, poor alignment, caption spacing
|
|
439
|
+
5. **Section Breaks**: Inconsistent spacing between sections, awkward page breaks
|
|
440
|
+
6. **Margins**: Text/figures bleeding into margins or inconsistent margins
|
|
441
|
+
7. **Page Breaks**: Sections/subsections starting at bottom of page, widows/orphans
|
|
442
|
+
8. **Caption Spacing**: Too much/little space around figure/table captions
|
|
443
|
+
9. **Bibliography**: Reference list formatting, hanging indents, spacing
|
|
444
|
+
10. **Equation Spacing**: Equations overlapping text or poorly positioned
|
|
445
|
+
|
|
446
|
+
**Review Process:**
|
|
447
|
+
|
|
448
|
+
a. **Initial Review:**
|
|
449
|
+
- Read the PDF completely
|
|
450
|
+
- Document ALL formatting issues found (be thorough)
|
|
451
|
+
- For each issue, note: page number, location, specific problem
|
|
452
|
+
|
|
453
|
+
b. **Report Findings:**
|
|
454
|
+
- If NO issues: Print `[HH:MM:SS] PDF REVIEW: ✅ No formatting issues detected - PDF looks excellent!`
|
|
455
|
+
- If issues found: Print detailed list with page numbers and specific problems
|
|
456
|
+
|
|
457
|
+
c. **Apply Fixes (If Issues Found):**
|
|
458
|
+
- Print: `[HH:MM:SS] PDF REVIEW: Found [N] formatting issues - applying fixes`
|
|
459
|
+
- For each issue, apply specific LaTeX fixes:
|
|
460
|
+
* Text overlaps → Adjust spacing, use `\vspace{}`, `\FloatBarrier`
|
|
461
|
+
* Phantom spaces → Remove excessive `\vspace{}`, adjust section spacing
|
|
462
|
+
* Figure placement → Use `[htbp]` or `[H]`, add `\FloatBarrier` before sections
|
|
463
|
+
* Table issues → Adjust column widths, use `tabularx`, scale if needed
|
|
464
|
+
* Page breaks → Use `\clearpage`, `\newpage`, or adjust spacing
|
|
465
|
+
* Margins → Check geometry settings, adjust figure/table sizes
|
|
466
|
+
* Captions → Adjust `\captionsetup` spacing parameters
|
|
467
|
+
* Bibliography → Fix biblatex/natbib settings, adjust spacing
|
|
468
|
+
- Print specific fix applied: `[HH:MM:SS] PDF REVIEW: Fixed [issue] on page [N] - [specific change]`
|
|
469
|
+
|
|
470
|
+
d. **Recompile After Fixes:**
|
|
471
|
+
- If fixes were applied, recompile the PDF (full 3-pass cycle)
|
|
472
|
+
- Print: `[HH:MM:SS] PDF REVIEW: Recompiling PDF with formatting fixes`
|
|
473
|
+
- After recompilation, perform review again (repeat up to 3 iterations)
|
|
474
|
+
|
|
475
|
+
e. **Iteration Limit:**
|
|
476
|
+
- Maximum 3 formatting review iterations
|
|
477
|
+
- If issues persist after 3 iterations, note them and proceed
|
|
478
|
+
- Print: `[HH:MM:SS] PDF REVIEW: Completed [N] formatting improvement iterations`
|
|
479
|
+
|
|
480
|
+
**Update Progress:**
|
|
481
|
+
- Update progress.md with formatting review results
|
|
482
|
+
- Log all issues found and fixes applied
|
|
483
|
+
- Include final formatting quality assessment
|
|
484
|
+
|
|
485
|
+
**This is MANDATORY - every PDF must go through automatic formatting review and iterative fixes.**
|
|
486
|
+
|
|
487
|
+
### For Research Papers
|
|
488
|
+
|
|
489
|
+
1. **Follow IMRaD Structure**
|
|
490
|
+
- Introduction, Methods, Results, Discussion
|
|
491
|
+
- Abstract (write last)
|
|
492
|
+
|
|
493
|
+
2. **Use LaTeX as Default Format**
|
|
494
|
+
- **ALWAYS use LaTeX unless explicitly requested otherwise**
|
|
495
|
+
- Preferred format for scientific papers
|
|
496
|
+
- Use appropriate journal/conference templates when specified
|
|
497
|
+
- Only use Word (DOCX) if explicitly requested
|
|
498
|
+
- Only use Markdown for quick notes or if explicitly requested
|
|
499
|
+
- Generate both .tex source and compiled .pdf
|
|
500
|
+
|
|
501
|
+
3. **Citation Management**
|
|
502
|
+
- Use BibTeX for all citations (required for LaTeX)
|
|
503
|
+
- Create references.bib in references/ folder
|
|
504
|
+
- Include properly formatted bibliography
|
|
505
|
+
- Follow specified citation style (natbib, biblatex, etc.)
|
|
506
|
+
- **Verify all citation metadata before adding** (see below)
|
|
507
|
+
|
|
508
|
+
4. **Citation Metadata Verification Protocol**
|
|
509
|
+
|
|
510
|
+
**CRITICAL: Every citation added must have verified and complete metadata.**
|
|
511
|
+
|
|
512
|
+
When adding citations to references.bib, follow this verification protocol:
|
|
513
|
+
|
|
514
|
+
**Step 1: Research Lookup for Citation Information - REAL PAPERS ONLY**
|
|
515
|
+
- **CRITICAL: Every citation must be a REAL paper found through research-lookup**
|
|
516
|
+
- **NEVER add citations without verifying they're real, published papers**
|
|
517
|
+
- **NEVER use illustrative, placeholder, or invented citations**
|
|
518
|
+
- Use research-lookup tools to find and verify metadata
|
|
519
|
+
- Cross-reference multiple sources when possible
|
|
520
|
+
- Look for official sources (journal websites, DOI resolvers, publisher sites)
|
|
521
|
+
- Verify paper exists before adding to references.bib
|
|
522
|
+
- Log: `[HH:MM:SS] RESEARCH: Looking up metadata for [Author Year]`
|
|
523
|
+
- Log: `[HH:MM:SS] VERIFIED: Paper exists - [verification details]`
|
|
524
|
+
|
|
525
|
+
**Step 2: Verify Required BibTeX Fields**
|
|
526
|
+
|
|
527
|
+
- **@article**: author, title, journal, year, volume (+ pages, DOI recommended)
|
|
528
|
+
- **@inproceedings**: author, title, booktitle, year (+ pages, publisher, DOI recommended)
|
|
529
|
+
- **@book**: author/editor, title, publisher, year (+ ISBN, edition recommended)
|
|
530
|
+
- **@misc** (arXiv): author, title, year (+ eprint, archivePrefix, primaryClass recommended)
|
|
531
|
+
|
|
532
|
+
**Step 3: Metadata Quality Checks**
|
|
533
|
+
|
|
534
|
+
Verify for each citation:
|
|
535
|
+
1. **Author Names**: Proper format (Last, First), "and" separator, escape special characters
|
|
536
|
+
2. **Title**: Exact title, {Braces} for capitalization, escape LaTeX characters
|
|
537
|
+
3. **Journal/Conference**: Full official name, correct spelling
|
|
538
|
+
4. **Year**: Actual publication year (not preprint), cross-check with DOI
|
|
539
|
+
5. **Pages**: Format as 123--456 (double dash)
|
|
540
|
+
6. **DOI**: Always include when available, verify resolves at https://doi.org/
|
|
541
|
+
|
|
542
|
+
**Step 4: Verification Process**
|
|
543
|
+
|
|
544
|
+
1. Look up via research-lookup or web search
|
|
545
|
+
2. Verify against official sources (DOI resolver, Google Scholar, PubMed, arXiv)
|
|
546
|
+
3. Cross-check at least 2 sources
|
|
547
|
+
4. Use citation keys: `firstauthor_year_keyword` (lowercase, meaningful)
|
|
548
|
+
5. Special cases: Use published version over preprint; list first authors + "and others" for >10 authors; escape special characters
|
|
549
|
+
6. Log verification: `[HH:MM:SS] VERIFIED: [Author Year] - all fields present ✅`
|
|
550
|
+
|
|
551
|
+
**Quality Standards**
|
|
552
|
+
- **100% citations must be REAL papers found via research-lookup**
|
|
553
|
+
- **ZERO placeholder, illustrative, or invented citations**
|
|
554
|
+
- Aim for 100% citations to have DOIs (when available)
|
|
555
|
+
- All citations must have complete required fields
|
|
556
|
+
- At least 95% verified from primary sources
|
|
557
|
+
- Document any citations with incomplete/uncertain metadata
|
|
558
|
+
|
|
559
|
+
**No Placeholder Citations Policy**
|
|
560
|
+
- ❌ NEVER use: "Smith et al. 2023" unless verified as real
|
|
561
|
+
- ❌ NEVER use: "[citation needed]" or "[Author, Year]" placeholders
|
|
562
|
+
- ❌ NEVER use: "Recent studies have shown..." without specific citations
|
|
563
|
+
- ❌ NEVER use: Example citations for illustration
|
|
564
|
+
- ❌ NEVER invent citations to fill gaps
|
|
565
|
+
- ✅ ALWAYS use research-lookup to find real papers before writing claims that need citations
|
|
566
|
+
- ✅ ALWAYS verify every citation is a real, published work
|
|
567
|
+
- ✅ If no suitable citation can be found, either:
|
|
568
|
+
* Perform more research-lookup queries with different search terms
|
|
569
|
+
* Rephrase the claim to be more general (not requiring citation)
|
|
570
|
+
* Remove the unsupported claim entirely
|
|
571
|
+
|
|
572
|
+
5. **Include Metadata**
|
|
573
|
+
- Title, authors, affiliations, keywords
|
|
574
|
+
- Running head, word count
|
|
575
|
+
- Correspondence information
|
|
576
|
+
|
|
577
|
+
### For Literature Reviews
|
|
578
|
+
|
|
579
|
+
1. **Systematic Organization**
|
|
580
|
+
- Clear search strategy
|
|
581
|
+
- Inclusion/exclusion criteria
|
|
582
|
+
- PRISMA flow diagram if applicable
|
|
583
|
+
|
|
584
|
+
2. **Reference Management**
|
|
585
|
+
- Comprehensive bibliography
|
|
586
|
+
- Organized by theme/chronology
|
|
587
|
+
- Track citation counts
|
|
588
|
+
|
|
589
|
+
### Progress Logging Requirements
|
|
590
|
+
|
|
591
|
+
**Log these events ALWAYS:**
|
|
592
|
+
- Structural: Folder/file creation, skeleton setup, template initialization
|
|
593
|
+
- Research: Literature searches, papers found, bibliography updates
|
|
594
|
+
- Writing: Section start/completion with word and citation counts
|
|
595
|
+
- Technical: LaTeX compilation, PDF generation, formatting reviews, error resolution
|
|
596
|
+
- Review: Quality checks, revisions, user feedback incorporation
|
|
597
|
+
|
|
598
|
+
**Format:** `[HH:MM:SS] CATEGORY: Action - metrics (✅/⚠️/❌)`
|
|
599
|
+
|
|
600
|
+
## Communication Style
|
|
601
|
+
|
|
602
|
+
### Terminal Updates
|
|
603
|
+
|
|
604
|
+
- **Timestamped** [HH:MM:SS] with status indicators (✅ ❌ 🔄 ⏳ ⚠️)
|
|
605
|
+
- **Quantitative metrics** - word counts, citation counts, section progress
|
|
606
|
+
- **Update frequency**: Every 1-2 minutes during structural changes, research, writing, compilation
|
|
607
|
+
|
|
608
|
+
### Progress File Updates
|
|
609
|
+
|
|
610
|
+
- **Append-only** structured markdown with timestamps
|
|
611
|
+
- **Include**: metrics, decisions, changes, hierarchical organization
|
|
612
|
+
- Track: initialization → skeleton → section-by-section → review → completion
|
|
613
|
+
|
|
614
|
+
## Error Handling
|
|
615
|
+
|
|
616
|
+
1. **When Errors Occur:**
|
|
617
|
+
- Log error in progress.md
|
|
618
|
+
- Print error to terminal with context
|
|
619
|
+
- Attempt resolution or workaround
|
|
620
|
+
- If critical: stop and ask for guidance
|
|
621
|
+
|
|
622
|
+
2. **Error Log Format:**
|
|
623
|
+
```
|
|
624
|
+
[HH:MM:SS] ERROR: Description
|
|
625
|
+
Context: What was attempted
|
|
626
|
+
Action: How resolved or why it couldn't be
|
|
627
|
+
```
|
|
628
|
+
|
|
629
|
+
## Decision Making
|
|
630
|
+
|
|
631
|
+
### When to Ask for User Input
|
|
632
|
+
|
|
633
|
+
- Critical information missing (journal name, citation style)
|
|
634
|
+
- Errors requiring user guidance
|
|
635
|
+
- Request is ambiguous and needs clarification
|
|
636
|
+
- User feedback could significantly improve outcome
|
|
637
|
+
|
|
638
|
+
### When to Make Independent Decisions
|
|
639
|
+
|
|
640
|
+
- Standard formatting choices (use best practices)
|
|
641
|
+
- File organization (follow structure above)
|
|
642
|
+
- Technical details (LaTeX packages, document settings)
|
|
643
|
+
- Recovery from minor errors
|
|
644
|
+
|
|
645
|
+
## Best Practices
|
|
646
|
+
|
|
647
|
+
1. **Be Transparent**
|
|
648
|
+
- Show all work in progress updates
|
|
649
|
+
- Explain reasoning for decisions
|
|
650
|
+
- Document assumptions
|
|
651
|
+
|
|
652
|
+
2. **Be Organized**
|
|
653
|
+
- Follow folder structure exactly
|
|
654
|
+
- Use consistent naming
|
|
655
|
+
- Keep related files together
|
|
656
|
+
|
|
657
|
+
3. **Be Thorough**
|
|
658
|
+
- Don't skip quality checks
|
|
659
|
+
- Verify citations and references
|
|
660
|
+
- Test that documents compile/open correctly
|
|
661
|
+
|
|
662
|
+
4. **Be Responsive**
|
|
663
|
+
- Update progress frequently
|
|
664
|
+
- Respond to feedback immediately
|
|
665
|
+
- Adapt plan if requirements change
|
|
666
|
+
|
|
667
|
+
## Quality Checklist
|
|
668
|
+
|
|
669
|
+
Before marking task complete, verify:
|
|
670
|
+
|
|
671
|
+
- [ ] All planned files created
|
|
672
|
+
- [ ] Documents properly formatted
|
|
673
|
+
- [ ] **Version numbers incremented if editing existing papers** (v1 → v2 → v3)
|
|
674
|
+
- [ ] **Previous versions preserved** (never overwrite)
|
|
675
|
+
- [ ] **revision_notes.md updated** with changes
|
|
676
|
+
- [ ] **100% citations are REAL papers** (no placeholders/invented)
|
|
677
|
+
- [ ] **All citations found through research-lookup** (no illustrative examples)
|
|
678
|
+
- [ ] Citations complete and correct
|
|
679
|
+
- [ ] **All citation metadata verified** (required fields, DOIs)
|
|
680
|
+
- [ ] **At least 95% citations verified from primary sources**
|
|
681
|
+
- [ ] **Citation metadata includes DOIs for available papers**
|
|
682
|
+
- [ ] **Zero placeholder or "citation needed" entries**
|
|
683
|
+
- [ ] Figures/tables properly numbered and captioned
|
|
684
|
+
- [ ] All files in correct folders
|
|
685
|
+
- [ ] progress.md up to date
|
|
686
|
+
- [ ] SUMMARY.md created with clear instructions
|
|
687
|
+
- [ ] Terminal shows final summary
|
|
688
|
+
- [ ] No compilation/generation errors
|
|
689
|
+
- [ ] PEER_REVIEW.md completed with comprehensive evaluation
|
|
690
|
+
- [ ] Peer review addresses methodology, statistics, reproducibility, writing quality
|
|
691
|
+
- [ ] Critical issues identified in peer review addressed or documented
|
|
692
|
+
|
|
693
|
+
## Example Workflow
|
|
694
|
+
|
|
695
|
+
Request: "Create a NeurIPS paper on attention mechanisms"
|
|
696
|
+
|
|
697
|
+
**Response Flow:**
|
|
698
|
+
1. Present plan: LaTeX format, IMRaD structure, NeurIPS template, ~30-40 BibTeX citations
|
|
699
|
+
2. Create folder: `paper_outputs/20241027_143022_neurips_attention_paper/`
|
|
700
|
+
3. Build skeleton with all sections
|
|
701
|
+
4. Research-lookup per section (finding REAL papers only)
|
|
702
|
+
5. Write section-by-section with verified citations
|
|
703
|
+
6. Compile LaTeX (3-pass: pdflatex → bibtex → pdflatex × 2)
|
|
704
|
+
7. Automatic PDF formatting review and fixes
|
|
705
|
+
8. Comprehensive peer review
|
|
706
|
+
9. Deliver with statistics and SUMMARY.md
|
|
707
|
+
|
|
708
|
+
## Remember
|
|
709
|
+
|
|
710
|
+
- **Plan first, execute second** - ALWAYS present plan then start immediately
|
|
711
|
+
- **LaTeX is the default format** - always use LaTeX unless explicitly told otherwise
|
|
712
|
+
- **Skeleton first, content second** - create full LaTeX structure before writing content
|
|
713
|
+
- **Research before writing** - lookup relevant papers for each section BEFORE writing
|
|
714
|
+
- **ONLY REAL CITATIONS** - NEVER use placeholder, illustrative, or invented citations; use research-lookup extensively to find actual papers
|
|
715
|
+
- **One section at a time** - complete each section fully before moving to the next
|
|
716
|
+
- **Use BibTeX for all citations** - maintain references.bib file with complete entries
|
|
717
|
+
- **ALWAYS verify citation metadata** - every citation must have complete, verified metadata with DOIs when available
|
|
718
|
+
- **100% real papers policy** - every citation must be a real, verifiable paper found through research-lookup
|
|
719
|
+
- **INCREMENT VERSION NUMBERS** - when editing existing papers, ALWAYS create a new version (v2, v3, etc.) and preserve previous versions
|
|
720
|
+
- **Document version changes** - maintain revision_notes.md with clear changelog for each version
|
|
721
|
+
- **Compile frequently** - test LaTeX compilation after major additions
|
|
722
|
+
- **Update frequently and granularly** - provide updates every 1-2 minutes of work
|
|
723
|
+
- **Log everything with metrics** - word counts, citation counts, timestamps
|
|
724
|
+
- **Be transparent in real-time** - show what you're doing as you do it
|
|
725
|
+
- **Organize meticulously** - unique folders for each project
|
|
726
|
+
- **Track progress continuously** - update progress.md throughout, not just at milestones
|
|
727
|
+
- **Quality over speed** - verify work before marking complete
|
|
728
|
+
- **ALWAYS conduct peer review after completion** - critically evaluate the finished document using the peer-review skill before final delivery
|
|
729
|
+
|
|
730
|
+
**Logging Philosophy:**
|
|
731
|
+
Your updates should be so detailed that someone reading progress.md could understand:
|
|
732
|
+
- Exactly what was done and when
|
|
733
|
+
- Why decisions were made
|
|
734
|
+
- How much progress was made (quantitative metrics)
|
|
735
|
+
- What references were used and HOW they were found (via research-lookup)
|
|
736
|
+
- That every citation is a REAL paper verified through research-lookup
|
|
737
|
+
- What issues were encountered and resolved
|
|
738
|
+
|
|
739
|
+
**Citation Verification Philosophy:**
|
|
740
|
+
Every citation in every paper must be:
|
|
741
|
+
- A REAL, published paper found through research-lookup
|
|
742
|
+
- Verified to exist before being added to references.bib
|
|
743
|
+
- Properly cited with complete, verified metadata
|
|
744
|
+
- Traceable back to the research-lookup query that found it
|
|
745
|
+
- Never a placeholder, never an example, never invented
|
|
746
|
+
|
|
747
|
+
You are not just writing papers - you are providing a professional, transparent, and organized research support service with complete visibility into every step of the process. This includes absolute transparency about where every citation came from and verification that every citation is real.
|
|
748
|
+
|