skills/veeramanikandanr48_research-paper-writer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial commit with translated description

Browse Source
This commit is contained in:
zlei9
2026-03-29 14:34:45 +08:00
commit 9d94771744
7 changed files with 1592 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

595
references/acm_formatting_specs.md Normal file
View File

@@ -0,0 +1,595 @@
# ACM Paper Formatting Specifications
Complete formatting guide based on ACM conference/journal paper template.
## Page Setup
### Page Size and Orientation
- **Size**: US Letter (8.5" × 11") or A4 (210mm × 297mm)
- **Orientation**: Portrait
### Margins
- **Top**: 1 inch (25.4mm)
- **Bottom**: 1 inch (25.4mm)
- **Left**: 0.75 inch (19.05mm)
- **Right**: 0.75 inch (19.05mm)
### Column Layout
- **Abstract**: Single column
- **Body**: Two columns
- **Column separation**: 0.33 inches (8.38mm)
## Typography
### Font Family
- **Primary**: Libertine (Linux Libertine)
- **Monospace**: Inconsolata or Courier
- **Fallback**: Times New Roman acceptable
### Font Sizes and Styles
**Title:**
- Size: 17pt
- Weight: Bold
- Alignment: Left
- Spacing: 12pt after
**Subtitle (if any):**
- Size: 14pt
- Weight: Regular
- Alignment: Left
**Author Names:**
- Size: 12pt
- Weight: Regular
- Alignment: Left
- Format: One author per line or comma-separated
**Author Affiliations:**
- Size: 10pt
- Weight: Regular
- Alignment: Left
- Format: Institution, City, Country
- Email: 10pt, monospace font
**Abstract:**
- Single column
- Size: 10pt
- Weight: Regular
- Alignment: Justified
- Heading: "ABSTRACT" in bold, small caps
**CCS Concepts:**
- Section after abstract
- Format: Bulleted list with concept hierarchy
- Size: 9pt
**Keywords:**
- After CCS Concepts
- Format: Comma-separated list
- Size: 9pt
**Section Headings (Level 1):**
- Size: 11pt
- Weight: Bold
- Case: Title Case
- Alignment: Left
- Numbering: 1, 2, 3...
- Spacing: 12pt before, 6pt after
**Subsection Headings (Level 2):**
- Size: 10pt
- Weight: Bold
- Case: Title Case
- Alignment: Left
- Numbering: 1.1, 1.2, 1.3...
- Spacing: 9pt before, 3pt after
**Sub-subsection Headings (Level 3):**
- Size: 10pt
- Weight: Italic
- Case: Title Case
- Alignment: Left
- Numbering: 1.1.1, 1.1.2...
- Spacing: 6pt before, 3pt after
**Body Text:**
- Size: 10pt
- Weight: Regular
- Alignment: Justified
- Line spacing: Single (1.0)
- Paragraph spacing: 6pt after
- First paragraph after heading: No indent
- Subsequent paragraphs: 0.5 inch indent OR no indent with spacing
**Figure Captions:**
- Size: 9pt
- Weight: Regular
- Format: "Figure X:" in bold, followed by caption
- Alignment: Left (below figure)
- Spacing: 6pt above caption
**Table Captions:**
- Size: 9pt
- Weight: Regular
- Format: "Table X:" in bold, followed by caption
- Alignment: Left (above table)
- Spacing: 6pt below caption
**Footnotes:**
- Size: 8pt
- Weight: Regular
- Numbering: Superscript numbers
- Placement: Bottom of column with separator line
**References:**
- Size: 9pt
- Weight: Regular
- Alignment: Left
- Numbering: [1], [2], [3]...
- Indentation: Hanging indent
- Spacing: 2pt between references
## Document Structure
### Title and Metadata (Single Column)
1. Title
2. Subtitle (optional)
3. Authors and affiliations
4. Abstract
5. CCS Concepts
6. Keywords
7. ACM Reference Format
### Body (Two Columns)
8. Main content sections
9. Acknowledgments
10. References
## Special Sections
### Abstract
Format:
```
ABSTRACT
Context-aware systems have become increasingly important...
```
- Heading in bold, small caps
- 150-250 words
- Single paragraph
- No citations
### CCS Concepts
Required section listing ACM Computing Classification concepts.
Format:
```
CCS CONCEPTS
• Human-centered computing → Ubiquitous and mobile computing;
• Software and its engineering → Context specific languages.
```
- Use official ACM CCS taxonomy
- Organized hierarchically with bullet points
- 3-6 concepts typical
### Keywords
Format:
```
KEYWORDS
context-awareness, ubiquitous computing, adaptation, personalization
```
- 4-8 keywords
- Comma-separated
- Lowercase (except proper nouns)
### ACM Reference Format
Appears at end of first page or after keywords:
Format:
```
ACM Reference Format:
John Smith and Jane Doe. 2025. Title of Paper. In Proceedings of
Conference Name (CONF '25), Month Day-Day, Year, City, Country.
ACM, New York, NY, USA, XX pages. https://doi.org/10.1145/XXXXXX.XXXXXX
```
## Numbering Conventions
### Sections
```
1 INTRODUCTION
2 RELATED WORK
2.1 Context Modeling
2.2 Adaptation Techniques
3 PROPOSED APPROACH
3.1 Architecture Overview
3.1.1 Context Acquisition Module
```
### Figures and Tables
- **Figures**: Numbered sequentially (Figure 1, Figure 2...)
- **Tables**: Numbered sequentially (Table 1, Table 2...)
- **Equations**: Numbered on right margin (1), (2), (3)...
## Special Elements
### Equations
- **Display equations**: Centered on separate line
- **Numbering**: Right-aligned equation number
- **Spacing**: 6pt before and after
Example:
```
E = mc² (1)
```
### Code Listings
- **Font**: Inconsolata or Courier (monospace)
- **Size**: 9pt
- **Background**: Light gray background optional
- **Line numbers**: Optional, on left margin
- **Caption**: Same format as figures
Example:
```python
def context_aware_function(context):
if context.location == "office":
return set_work_mode()
return set_personal_mode()
```
### Algorithms
- Use algorithm environment
- Line numbering on left
- Keywords in bold
- Comments in italic
### Lists
**Bulleted lists:**
- Use standard bullet (•)
- Indent 0.25 inches
- Spacing: 3pt between items
**Numbered lists:**
- Use (1), (2), (3) or 1., 2., 3.
- Indent 0.25 inches
- Spacing: 3pt between items
**Description lists:**
- Term in bold, followed by description
- Hanging indent for description
## Figures and Tables
### Figure Guidelines
- **Position**: Top or bottom of column
- **Width**: Single-column or double-column (spanning both)
- **Quality**: Vector graphics preferred (PDF, EPS)
- **Resolution**: Minimum 300 DPI for raster images
- **Color**: Full color acceptable for online; consider grayscale printing
- **Format**: PDF, PNG, JPG, EPS
### Figure Captions
Format:
```
Figure 1: System architecture showing the main components
including context acquisition, reasoning, and adaptation modules.
```
- "Figure X:" in bold
- Caption text follows
- Place below figure
- Can span multiple lines
- Left-aligned
### Table Guidelines
- **Border**: Minimal lines (top, bottom, below header)
- **Header**: Bold text
- **Alignment**: Numbers right-aligned, text left-aligned
- **Font**: Same as body or one size smaller
- **Shading**: Light gray for header row optional
### Table Captions
Format:
```
Table 1: Performance comparison across three datasets
```
- "Table X:" in bold
- Caption text follows
- Place above table
- Left-aligned
Example table:
```
Table 1: Accuracy Results
Dataset Baseline Proposed
────────────────────────────────
Dataset A 87.3% 94.2%
Dataset B 89.1% 95.7%
Dataset C 85.7% 93.4%
────────────────────────────────
```
## Citations and References
### In-Text Citations
ACM uses numbered citations in square brackets:
Examples:
- "Recent work has shown [1]..."
- "Several studies [2, 3, 4] demonstrate..."
- "As Smith et al. [5] noted..."
### Reference List Format
**Section title**: "REFERENCES" (all caps, bold)
**Journal article:**
```
[1] Author1 Name, Author2 Name, and Author3 Name. Year.
Title of article. Journal Name Volume, Issue (Month Year),
pages. DOI:10.1145/XXXXXXX
```
**Conference paper:**
```
[2] Author1 Name and Author2 Name. Year. Title of paper.
In Proceedings of Conference Name (CONF 'YY), Month,
City, Country. ACM, New York, NY, USA, pages.
DOI:10.1145/XXXXXXX
```
**Book:**
```
[3] Author Name. Year. Book Title. Publisher, City, Country.
```
**Book chapter:**
```
[4] Author Name. Year. Chapter Title. In Book Title,
Editor Name (Ed.). Publisher, City, Country, pages.
```
**Website/Online:**
```
[5] Author Name. Year. Page Title. Website Name.
Retrieved Month Day, Year from URL
```
**Technical report:**
```
[6] Author Name. Year. Report Title. Technical Report Number.
Institution, City, Country.
```
**Rules:**
- Full first and last names (not initials)
- Year after authors
- DOI required when available
- URLs should be hyperlinked
- Alphabetical by first author's last name
- Hanging indent format
## Additional Front Matter Elements
### Copyright Notice
Appears at bottom of first column on page 1:
Format depends on publication rights:
```
Permission to make digital or hard copies of all or part of this work...
© 2025 Association for Computing Machinery.
ACM ISBN 978-1-4503-XXXX-X/YY/MM...$15.00
https://doi.org/10.1145/XXXXXX.XXXXXX
```
(Usually auto-generated by ACM template)
### Conference Information
Top of first page:
```
CONF '25, Month Day-Day, Year, City, Country
© 2025 Copyright held by owner/author(s). Publication rights licensed to ACM.
```
## Acknowledgments
- Separate section before references
- **Heading**: "ACKNOWLEDGMENTS" (not "ACKNOWLEDGEMENTS")
- No section number
- Thank funding sources, contributors, reviewers
- Brief (1-2 paragraphs)
Example:
```
ACKNOWLEDGMENTS
This work was supported by NSF Grant No. XXXXXXX. We thank
the anonymous reviewers for their valuable feedback.
```
## Author Information
### Multiple Authors
Format options:
**Option 1: List format**
```
Author One
Institution
email@domain.com
Author Two
Institution
email@domain.com
```
**Option 2: Inline format**
```
Author One (email@domain.com), Institution;
Author Two (email@domain.com), Institution
```
### Author Footnotes
- Use superscript symbols (*, †, ‡)
- Explain equal contribution, corresponding author, etc.
## Special Content Types
### Sidebars and Boxes
- Light background color
- Border around content
- Used for examples, definitions, or supplementary material
- Same font size as body
### Theorems and Proofs
- **Theorem**: Bold heading, italic content
- **Proof**: Italic heading, regular content
- End proof with □ symbol
### Definitions
- **Format**: Bold term followed by definition
- Numbered if multiple definitions
## Color and Graphics
### Color Usage
- Full color accepted for digital publications
- Consider colorblind-friendly palettes
- Ensure legibility in grayscale for printing
- Use patterns/textures in addition to color
### Image Requirements
- **Resolution**: 300 DPI minimum
- **Format**: PDF, PNG (for screenshots), JPG
- **Vector preferred**: For diagrams, charts, graphs
- **File size**: Keep reasonable (< 5 MB per image)
## Two-Column Formatting Rules
### Column Breaks
- Columns should be approximately equal height
- Balance columns on final page
- Keep related content together (avoid splitting paragraphs)
### Spanning Columns
- Figures and tables can span both columns
- Use when content is too wide for single column
- Place at top or bottom of page
### Widows and Orphans
- Avoid single lines at top/bottom of columns
- Keep at least 2 lines of paragraph together
## File Preparation
### LaTeX
Use ACM Master Article Template:
```latex
\documentclass[sigconf]{acmart}
```
Common document classes:
- `sigconf`: Conference proceedings
- `sigplan`: SIGPLAN proceedings
- `acmsmall`: Small journal format
- `acmlarge`: Large journal format
### Microsoft Word
- Use official ACM Word template
- Available from ACM website
- Includes styles for all elements
### PDF Requirements
- **PDF/A compliant** preferred
- **Fonts embedded**: All fonts must be embedded
- **Hyperlinks**: Active and colored blue
- **Bookmarks**: Section headings as bookmarks
- **Metadata**: Include title, authors, keywords
## Common Mistakes to Avoid
1. **Missing required sections**: CCS Concepts, Keywords, ACM Reference Format
2. **Wrong font**: Using Times instead of Libertine
3. **Incorrect citation format**: Not following ACM style exactly
4. **Missing DOIs**: References should include DOIs when available
5. **Copyright notice**: Modifying or removing copyright block
6. **Column imbalance**: Large white space in columns
7. **Figure quality**: Low resolution or pixelated images
8. **Heading capitalization**: Using all caps instead of title case
9. **Author format**: Not following ACM author format
10. **Reference format**: Using abbreviated names instead of full names
## Checklist for Final Submission
- [ ] Correct document class for publication type
- [ ] Title and subtitle properly formatted
- [ ] All authors and affiliations included
- [ ] Abstract 150-250 words
- [ ] CCS Concepts section included with appropriate concepts
- [ ] Keywords section included (4-8 keywords)
- [ ] ACM Reference Format section included
- [ ] Two-column layout for body (single column for abstract)
- [ ] All section headings numbered and formatted correctly
- [ ] All figures have captions below
- [ ] All tables have captions above
- [ ] All figures and tables referenced in text
- [ ] All references follow ACM format
- [ ] Full author names in references (not initials)
- [ ] DOIs included for all references when available
- [ ] Acknowledgments section (if applicable)
- [ ] All fonts embedded in PDF
- [ ] Copyright notice included (if required)
- [ ] PDF hyperlinks working
- [ ] File size acceptable (< 25 MB typically)
- [ ] Spell-check completed
- [ ] Consistent terminology throughout
## Template Variations
### Conference Proceedings
- `\documentclass[sigconf]{acmart}`
- Two-column format
- Copyright block required
- Page limit enforced
### Journal Articles
- `\documentclass[acmsmall]{acmart}` or `acmlarge`
- More flexible length
- Different heading styles
- May include received/revised dates
### Extended Abstracts
- Shorter format (2-4 pages)
- May omit some sections
- Abbreviated evaluation
## ACM-Specific Style Conventions
### Terminology
- "Section" not "chapter"
- "Figure" not "Fig." in running text (though "Fig." in captions okay)
- Use em-dash (—) not double hyphen (--)
- Use proper quotation marks (" ") not straight quotes (")
### Capitalization
- Section titles: Title Case
- Figure/Table captions: Sentence case after "Figure X:" or "Table X:"
- CCS concepts: Follow official taxonomy capitalization
### Spacing
- One space after periods
- No space before punctuation
- Space after commas, colons, semicolons
## Additional Resources
- ACM Author Center: https://authors.acm.org/
- ACM Templates: https://www.acm.org/publications/proceedings-template
- ACM CCS Generator: https://dl.acm.org/ccs
- ACM Reference Format Guide: https://www.acm.org/publications/authors/reference-formatting
- LaTeX Template Documentation: https://www.ctan.org/pkg/acmart

408
references/ieee_formatting_specs.md Normal file
View File

@@ -0,0 +1,408 @@
# IEEE Paper Formatting Specifications
Complete formatting guide based on IEEE conference/journal paper template.
## Page Setup
### Page Size and Orientation
- **Size**: A4 (210mm × 297mm)
- **Orientation**: Portrait
### Margins
- **Top**: 19mm (0.75 inches)
- **Bottom**: 43mm (1.69 inches) - larger for page numbers
- **Left**: 14.32mm (0.564 inches)
- **Right**: 14.32mm (0.564 inches)
### Column Layout
- **Number of columns**: 2
- **Column width**: Calculated automatically based on page width minus margins
- **Column separation**: 4.22mm (0.166 inches)
- **Column balance**: Balance final page columns if possible
## Typography
### Font Family
- **All text**: Times New Roman
- **Fallback**: Times, serif
### Font Sizes and Styles
**Title:**
- Size: 24pt
- Weight: Bold
- Case: Title Case
- Alignment: Centered
- Spacing: 18pt after
**Author Names:**
- Size: 11pt
- Weight: Regular
- Alignment: Centered
- Spacing: 12pt after
**Author Affiliations:**
- Size: 10pt
- Weight: Regular (Italic for email)
- Alignment: Centered
- Spacing: 18pt after
**Abstract Heading:**
- Size: 10pt
- Weight: Bold
- Case: Title Case
- Alignment: Left
- Style: Italic
**Abstract Text:**
- Size: 10pt
- Weight: Regular (Bold for "Keywords:")
- Alignment: Justified
- Indentation: None
- Spacing: 18pt after
**Section Headings (Level 1):**
- Size: 10pt
- Weight: Bold
- Case: UPPERCASE
- Alignment: Left (centered also acceptable for IEEE)
- Numbering: Roman numerals (I, II, III) or Arabic (1, 2, 3)
- Spacing: 6pt before, 3pt after
**Subsection Headings (Level 2):**
- Size: 10pt
- Weight: Bold Italic
- Case: Title Case
- Alignment: Left
- Numbering: A, B, C or 1.1, 1.2, 1.3
- Spacing: 6pt before, 3pt after
**Sub-subsection Headings (Level 3):**
- Size: 10pt
- Weight: Regular Italic
- Case: Sentence case
- Alignment: Left
- Numbering: 1), 2), 3) or 1.1.1, 1.1.2
- Spacing: 3pt before, 3pt after
**Body Text:**
- Size: 10pt
- Weight: Regular
- Alignment: Justified
- Line spacing: Single (1.0)
- Paragraph spacing: 3pt after
- Indentation: None (block paragraphs)
**Figure Captions:**
- Size: 8pt
- Weight: Regular
- Format: "Fig. X." in bold, followed by caption text
- Alignment: Centered
- Spacing: 6pt before figure, 12pt after caption
**Table Captions:**
- Size: 8pt
- Weight: Regular
- Format: "TABLE X" in uppercase, centered above table; caption text below
- Alignment: Centered
- Spacing: 6pt before caption, 6pt after table
**Footnotes:**
- Size: 8pt
- Weight: Regular
- Numbering: Superscript numbers
- Placement: Bottom of column
**References:**
- Size: 10pt (reference number 8pt)
- Weight: Regular
- Alignment: Left
- Numbering: [1], [2], [3]...
- Indentation: Hanging indent after number
- Spacing: 0pt between references
## Numbering Conventions
### Sections
Two acceptable styles:
**Style 1: Roman numerals**
```
I. INTRODUCTION
II. RELATED WORK
A. Context Modeling
B. Adaptation Techniques
III. PROPOSED APPROACH
```
**Style 2: Arabic numerals**
```
1. INTRODUCTION
2. RELATED WORK
2.1 Context Modeling
2.2 Adaptation Techniques
3. PROPOSED APPROACH
```
### Figures and Tables
- **Figures**: Numbered sequentially (Fig. 1, Fig. 2, Fig. 3...)
- **Tables**: Numbered sequentially (TABLE I, TABLE II or Table 1, Table 2...)
- **Equations**: Numbered on right margin (1), (2), (3)...
## Special Elements
### Equations
- **Inline**: Use inline math for simple expressions: $x + y = z$
- **Display**: Center important equations on separate line
- **Numbering**: Right-aligned equation number in parentheses
- **Spacing**: 6pt before and after
- **Font**: Times New Roman or Symbol font for math
Example:
```
E = mc² (1)
```
### Algorithms and Code
- **Font**: Courier New or other monospace font
- **Size**: 9pt
- **Placement**: Within figure environment
- **Caption**: "Fig. X. Algorithm description"
- **Indentation**: Preserve code structure
### Lists
**Bulleted lists:**
- Use bullet points (•)
- Indent by 5mm from margin
- Spacing: 0pt between items
**Numbered lists:**
- Use 1), 2), 3) or 1., 2., 3.
- Indent by 5mm from margin
- Align text with item number
### Quotations
- Short quotes (< 3 lines): Inline with quotation marks
- Long quotes: Indented block, 9pt font, no quotes
- Always cite source
## Figures and Tables Guidelines
### Figure Placement
- **Position**: Top or bottom of column preferred
- **Width**: Single-column (width of one column) or double-column (spans both columns)
- **Centering**: Center within column or page
- **Quality**: Minimum 300 DPI for images
- **Format**: Vector (PDF, EPS) preferred; raster (PNG, JPG) acceptable
- **Color**: Use grayscale or ensure prints clearly in grayscale
### Figure Captions
Format:
```
Fig. 1. System architecture showing the three main components:
context acquisition, reasoning engine, and adaptation module.
```
**Rules:**
- "Fig." abbreviation, not "Figure"
- Number followed by period
- Caption text starts with capital letter
- Can be multiple sentences
- Place below figure
### Table Formatting
- **Border**: Use horizontal lines only (top, bottom, below header)
- **Header**: Bold text in first row
- **Alignment**: Numbers right-aligned, text left-aligned
- **Spacing**: Compact spacing within table
- **Font**: Same as body text (10pt) or slightly smaller (9pt)
Example:
```
TABLE I
PERFORMANCE COMPARISON
Method Accuracy Time (ms)
───────────────────────────────────
Baseline 87.3% 145
Proposed 94.2% 132
───────────────────────────────────
```
**Caption placement:**
- Table number and title above table (centered)
- Additional caption text below table (centered)
### Table Captions
Format:
```
TABLE I
PERFORMANCE COMPARISON ACROSS THREE DATASETS
```
## Header and Footer
### Running Headers
- **Odd pages**: Paper title (right-aligned)
- **Even pages**: Author names (left-aligned)
- **Font**: 8pt
- **Position**: Top margin area
(Note: Many IEEE conferences omit running headers)
### Page Numbers
- **Position**: Bottom center
- **Font**: 10pt
- **Format**: Simple number (1, 2, 3...)
- **Start**: Page 1 on title page (may be suppressed for submission)
## Citations and References
### In-Text Citations
Format: [1], [2, 3], [5-7]
Examples:
- "Recent work [1] has shown..."
- "Several studies [2, 3, 4] demonstrate..."
- "As noted in [5], context awareness..."
### Reference List
**Section title**: "REFERENCES" or "REFERENCES" (all caps, centered or left)
**Format by type:**
**Journal article:**
```
[1] A. Author, B. Author, and C. Author, "Title of paper,"
Journal Name, vol. X, no. Y, pp. ZZZ-ZZZ, Month Year.
```
**Conference paper:**
```
[2] A. Author and B. Author, "Title of paper," in Proc.
Conference Name (CONF 'YY), City, Country, Year,
pp. XXX-XXX.
```
**Book:**
```
[3] A. Author, Book Title, Edition. City: Publisher, Year.
```
**Book chapter:**
```
[4] A. Author, "Chapter title," in Book Title, B. Editor, Ed.
City: Publisher, Year, pp. XXX-XXX.
```
**Technical report:**
```
[5] A. Author, "Title," Company/Institution, City, State,
Country, Tech. Rep. Number, Year.
```
**Website:**
```
[6] A. Author. "Page title." Website Name. Accessed: Month
Day, Year. [Online]. Available: http://url
```
**Rules:**
- List references in order of first citation
- Use initials for first/middle names
- Italicize journal/book titles
- Use quotation marks for article/paper titles
- Include DOI if available: doi: 10.1234/example
- Hanging indent after reference number
- Abbreviate author names consistently
## Acronyms and Abbreviations
- Define on first use: "Context-Aware Systems (C-AS)"
- Use consistently after definition
- Common technical abbreviations okay: API, CPU, RAM, etc.
- Measurement units: use standard abbreviations (mm, kg, MHz)
## Hyphenation and Line Breaks
- **Hyphenation**: Automatic hyphenation allowed
- **Line breaks**: Avoid widows and orphans
- **Section breaks**: Major sections start at top of column when possible
## Color Usage
- Use color sparingly
- Ensure readability in grayscale
- Test figures print clearly in black and white
- Use patterns/textures in addition to color for distinction
## File Preparation
### Submission Format
- **PDF**: Primary format for submission
- **Source files**: LaTeX or Word source may be required
- **Figures**: Separate high-resolution files may be needed
- **Fonts**: Embed all fonts in PDF
### PDF Requirements
- **Version**: PDF 1.4 or higher
- **Fonts**: All fonts embedded
- **Images**: Minimum 300 DPI
- **Page size**: Exact A4 (no cropmarks)
- **Color space**: RGB or grayscale
- **File size**: Typically < 10 MB
## Common Mistakes to Avoid
1. **Wrong margins**: Using default Word/LaTeX margins
2. **Wrong font**: Using Arial or other sans-serif fonts
3. **Single column abstract**: Should be two-column
4. **Centered section headings**: Usually left-aligned
5. **Figure quality**: Low-resolution or pixelated images
6. **Caption format**: Wrong placement or format
7. **Reference format**: Inconsistent citation style
8. **Page numbers**: Wrong position or format
9. **Line spacing**: Using double-spacing instead of single
10. **Paragraph indentation**: Using indent instead of block style
## Tools and Templates
### LaTeX
Use IEEE conference/journal template:
```latex
\documentclass[conference]{IEEEtran}
```
### Microsoft Word
Download official IEEE Word template from IEEE website
### Formatting Checkers
- IEEE PDF eXpress for validation
- Online margin checkers
- Font embedding validators
## Checklist for Final Submission
- [ ] Page size: A4 (210mm × 297mm)
- [ ] Margins: 19mm top, 43mm bottom, 14.32mm left/right
- [ ] Font: Times New Roman throughout
- [ ] Two-column layout with 4.22mm spacing
- [ ] Section headings formatted correctly
- [ ] All figures have captions below
- [ ] All tables have captions above
- [ ] All figures/tables referenced in text
- [ ] Reference list formatted correctly
- [ ] All fonts embedded in PDF
- [ ] Page numbers included (if required)
- [ ] File size acceptable
- [ ] PDF prints correctly
- [ ] All acronyms defined on first use
- [ ] No orphan headings (heading alone at column bottom)
## Additional Resources
- IEEE Author Center: https://journals.ieeeauthorcenter.ieee.org/
- IEEE Templates: https://www.ieee.org/conferences/publishing/templates.html
- IEEE Reference Guide: https://journals.ieeeauthorcenter.ieee.org/create-your-ieee-article/authoring-tools-and-templates/ieee-reference-guide/
- IEEE PDF eXpress: Check with conference/journal for PDF validation service

295
references/writing_style_guide.md Normal file
View File

@@ -0,0 +1,295 @@
# Academic Writing Style Guide
This guide extracts writing conventions from high-quality academic papers on context-aware systems and large vision-language models.
## Voice and Tone
### Formal Academic Voice
- Use third-person perspective when possible
- Maintain objectivity and avoid emotional language
- Be precise and concise
- Example: "This paper presents..." rather than "We excitedly present..."
### Tense Usage
- **Present tense**: For established facts, general truths, and paper structure
- "Context-aware systems adapt to user environments"
- "This paper surveys recent advances in..."
- **Past tense**: For specific studies, experiments conducted, and historical events
- "Smith et al. conducted experiments on..."
- "The system was evaluated using..."
- **Future tense**: For planned work or implications
- "Future research will explore..."
## Structural Patterns
### Abstract Writing
Pattern observed in successful papers:
1. **Opening sentence**: Broad context establishing importance
- "Context-aware systems have become increasingly important in ubiquitous computing environments."
2. **Problem identification**: Specific gap or challenge
- "However, engineering such systems poses significant challenges in requirements elicitation and validation."
3. **Solution/Approach**: What the paper does
- "This paper presents a comprehensive survey of engineering practices for context-aware systems."
4. **Key findings/contributions**: Main results
- "We identify 47 approaches across four lifecycle phases and provide a taxonomy of techniques."
5. **Implications**: Why it matters
- "Our findings provide guidance for practitioners in selecting appropriate engineering methods."
### Introduction Structure
Observed effective pattern (inverted pyramid):
1. **Motivation paragraph**: Real-world context and importance
- Start with broad domain relevance
- Use concrete examples or scenarios
- Establish "why should readers care?"
2. **Problem statement**: Specific challenges
- Identify gaps in current approaches
- Quantify the problem if possible
- Show inadequacy of existing solutions
3. **Proposed solution**: High-level overview
- Briefly describe approach without details
- Highlight key innovations
4. **Contributions**: Numbered list (3-5 items)
- Be specific: "A taxonomy of..." not "We discuss..."
- Focus on tangible outputs: frameworks, algorithms, empirical findings
5. **Paper organization**: Roadmap
- "The rest of this paper is organized as follows. Section 2..."
### Related Work Section
Effective patterns:
- **Thematic grouping**: Organize by approach type, not chronologically
- "Requirements Engineering Approaches"
- "Runtime Adaptation Techniques"
- "Evaluation Methodologies"
- **Comparative analysis**: Explicitly compare
- "Unlike [X] which focuses on Y, our approach..."
- "[A] addresses Z but does not consider..."
- "While [B] provides..., it requires..."
- **Gap identification**: Lead to your contribution
- "However, these approaches share a common limitation..."
- "To the best of our knowledge, no prior work has..."
### Methodology/Approach Section
Observed structure:
1. **Overview**: High-level description with diagrams
2. **Components**: Break down into subsystems/phases
3. **Details**: Algorithms, procedures, design decisions
4. **Rationale**: Justify choices made
Use subsections liberally:
- 4.1 System Architecture
- 4.2 Context Acquisition Module
- 4.3 Reasoning Engine
- 4.4 Adaptation Mechanism
### Results Section
Patterns from strong papers:
- **Lead with data**: Start with tables/figures
- **Describe objectively**: "Figure 3 shows that accuracy increases..."
- **Quantify everything**: Specific numbers, percentages, statistical significance
- **Compare baselines**: "Our approach achieves 94.2% accuracy compared to 87.3% for [baseline]"
- **Explain unexpected results**: Don't hide negative findings
### Discussion Section
Purpose: Interpret results, not just report them
- **Implications**: What do results mean?
- **Limitations**: Acknowledge threats to validity
- **Design choices**: Reflect on decisions made
- **Generalizability**: Where else does this apply?
### Conclusion Section
Effective pattern:
1. Restate the problem (1 sentence)
2. Summarize approach (1-2 sentences)
3. Key findings/contributions (2-3 sentences)
4. Broader impact (1 sentence)
5. Future directions (2-3 specific items)
Keep it concise (typically 1/2 to 3/4 page).
## Language Conventions
### Technical Precision
**Acronyms and Abbreviations:**
- Define on first use: "Context-Aware Systems (C-AS)"
- Use consistently throughout
- Common in field: LLM, API, ML, NLP, etc.
**Terminology Consistency:**
- Choose one term and stick with it
- "user" vs "end-user" vs "actor"
- "approach" vs "method" vs "technique"
- Create a terminology table if needed
**Quantification:**
- Avoid vague quantifiers without data
- Bad: "significantly improved"
- Good: "improved accuracy by 12.3% (p < 0.05)"
- Use precise numbers: "73 papers" not "many papers"
### Sentence Structure
**Complexity Balance:**
- Mix simple and complex sentences
- Use subordinate clauses for nuance
- Break up long sentences (>30 words typically too long)
**Active vs Passive Voice:**
- Prefer active for clarity: "We implemented..."
- Use passive when actor is unimportant: "Data was collected from..."
- Passive for objectivity: "The system was evaluated..."
**Transition Words:**
Observed frequent usage:
- Contrast: however, nevertheless, in contrast, conversely
- Addition: furthermore, moreover, additionally, similarly
- Causation: therefore, consequently, as a result, thus
- Example: for instance, for example, specifically, namely
- Summary: in summary, overall, in conclusion
### Common Phrases in Academic Writing
**Introducing work:**
- "This paper presents/proposes/introduces..."
- "We describe/investigate/analyze..."
- "Our work focuses on/addresses/tackles..."
**Stating problems:**
- "A key challenge is..."
- "However, this approach suffers from..."
- "Existing methods fail to..."
**Describing contributions:**
- "The main contribution of this work is..."
- "We make the following contributions:"
- "Our approach offers several advantages..."
**Referencing literature:**
- "Recent work has shown..." [1, 2]
- "Smith et al. demonstrated..." [3]
- "As noted by Jones [4]..."
- "Prior studies [5, 6, 7] have explored..."
**Presenting results:**
- "Our experiments demonstrate that..."
- "As shown in Table 2..."
- "Figure 4 illustrates..."
- "The results indicate that..."
**Expressing limitations:**
- "One limitation of our approach is..."
- "While our method shows promise, it..."
- "A potential threat to validity is..."
## Paragraph Construction
### Topic Sentences
- Start each paragraph with a clear topic sentence
- Make the main point immediately clear
- Use topic sentences to show logical flow
### Paragraph Length
- Typically 4-8 sentences
- One main idea per paragraph
- Use white space for readability
### Paragraph Transitions
- Link paragraphs logically
- Use transition sentences or phrases
- Create narrative flow
## Citation Practices
### When to Cite
- Any prior work that relates to yours
- Background information not common knowledge
- Methods or datasets from others
- Claims that need support
- Direct quotes (rare in technical papers)
### Citation Density
Observed patterns:
- Introduction: 5-10 citations
- Related Work: Heavy (30-50% of content)
- Methodology: Moderate (cite tools, algorithms used)
- Results: Light (cite baselines)
- Discussion: Moderate (compare with literature)
### Citation Integration
- **Parenthetical**: "Context awareness improves usability [1, 2]."
- **Narrative**: "Smith et al. [3] demonstrated that..."
- **Multiple**: Group related citations [4, 5, 6]
## Figures and Tables
### Purpose
- Figures: Show architecture, workflows, trends, comparisons
- Tables: Present structured data, results, comparisons
### Captions
- Self-contained: Readable without reading text
- Specific: "Accuracy comparison across three datasets" not "Results"
- Context: Explain abbreviations in caption
### In-text References
- Always reference: "as shown in Figure 3"
- Describe what to notice: "Figure 3 shows that accuracy increases with training data"
- Don't just state "see Figure 3" without context
## Domain-Specific Conventions
### Context-Aware Systems Literature
- Emphasize adaptability and personalization
- Discuss context acquisition, modeling, reasoning
- Address privacy and user trust
- Consider deployment challenges
### Machine Learning/AI Papers
- Report multiple metrics (accuracy, precision, recall, F1)
- Include ablation studies
- Discuss computational complexity
- Address ethical considerations
- Ensure reproducibility details
## Quality Indicators
Strong academic papers demonstrate:
1. **Clarity**: Ideas presented logically and understandably
2. **Rigor**: Thorough methodology and evaluation
3. **Originality**: Novel contribution clearly stated
4. **Relevance**: Connection to important problems
5. **Completeness**: All claims supported, limitations acknowledged
6. **Consistency**: Terminology, notation, style throughout
7. **Reproducibility**: Sufficient detail for replication
## Common Pitfalls to Avoid
1. **Overclaiming**: Avoid "revolutionary", "unprecedented" without strong evidence
2. **Vagueness**: Be specific about contributions and results
3. **Poor organization**: Ensure logical flow between sections
4. **Insufficient related work**: Show awareness of field
5. **Weak evaluation**: Need rigorous validation of claims
6. **Missing limitations**: Acknowledge weaknesses
7. **Inconsistent terminology**: Use terms consistently
8. **Unclear contributions**: State explicitly what is novel
9. **Excessive jargon**: Define technical terms appropriately
10. **No context**: Explain why the work matters
## Writing Process Tips
1. **Outline first**: Structure before writing
2. **Write iteratively**: Don't aim for perfection in first draft
3. **Start with easiest section**: Often methodology
4. **Write abstract last**: After content is finalized
5. **Get feedback early**: From colleagues or advisors
6. **Read aloud**: Catch awkward phrasing
7. **Edit ruthlessly**: Remove unnecessary words
8. **Check consistency**: Terminology, notation, citations
9. **Verify all claims**: Every statement should be defensible
10. **Polish formatting**: Final pass for consistency