# awesome-ieee-report

Adopt this skill: https://proskills.md/skills/other/enesdemir143-awesome-ieee-report

Page: https://proskills.md/skills/other/enesdemir143-awesome-ieee-report
This document is the public skill bundle for that page. It contains SKILL.md and every helper file the catalog carries. No login is required.

## File: SKILL.md
size: 10607
sha: 3e04cccfebecea2e0a840963dffe6dadf5300cd0
upstream: https://github.com/enesdemir143/awesome-ieee-report/blob/HEAD/SKILL.md

````text
---
name: awesome-ieee-report
description: Generates IEEE-format LaTeX technical reports from project requirements and codebase evidence, using academic prose, pseudocode-only explanations, BibTeX references, and IEEEtran formatting.
---

# LaTeX Technical Report Creator

Creates IEEE-format LaTeX technical reports for software and engineering projects. The skill reads a project's requirement document (if available), analyzes the codebase for evidence, and produces a pure academic report with no code references.

## Non-Negotiable Rules

Apply these rules on every run unless the user explicitly overrides them:

1. **Language**: Report body language follows the user's preference (default: English). Turkish is used when the user explicitly requests it.
2. **Requirement-first (when available)**: Section headings and coverage are driven by the project requirement document, not by convenience. If no requirement document exists, use the standard IEEE section structure as baseline.
3. **No source code dump**: Do not paste project source code blocks into the report.
4. **Pseudocode only**: Include algorithm-level pseudocode (IEEE `algorithm` environment) for core flows instead of raw implementation code.
5. **Figures as placeholders**: All figures are inserted as labeled placeholders. Real screenshots are added manually by the author. Never generate or embed actual images during skill execution.
6. **Consistency gate**: Report statements must be checked against actual code before finalizing.
7. **NO code artifacts in report body**: Never include file paths (.dart, .py, .ts, .json, etc.), class names, function names, variable names, directory structures, or any implementation-level identifiers in the report text. The report is a pure academic document — describe WHAT the system does and HOW it works conceptually, not WHERE the code lives.
8. **Minimum 3 figures**: Every report must include at least 3 figure placeholder entries with capture intent description.
9. **Academic tone**: Write as if submitting to an IEEE conference. No informal language, no first-person singular, no code jargon. Use domain vocabulary (algorithm, module, layer, mechanism, component) instead of implementation vocabulary (service, controller, repository, widget).
10. **IEEE format**: Use `\documentclass[conference]{IEEEtran}`, minimum 4 pages in two-column format.
11. **Assignment document is not a bibliography source by default**: The requirement/assignment document defines coverage obligations, but it should not automatically appear in the final bibliography unless the user explicitly asks for it.
12. **Independent academic narration**: The report must synthesize evidence into original academic prose rather than shadowing the wording, enumeration style, or example framing of the requirement handout.
13. **Table-first compression**: Long enumerations such as option mappings, inventories, thresholds, parameter groups, and metric sets should be converted into compact `booktabs` tables when this improves IEEE two-column readability.
14. **Float hygiene**: Avoid placing several large tables/figures back-to-back in the same local area when this creates obvious white-space holes or pushes related prose apart; distribute floats across adjacent narrative blocks when needed.

If any rule conflicts with user instruction, follow the user instruction and explicitly note the override.

## When To Use

Use this skill when requests include terms like:
- technical report / teknik rapor
- latex report
- ieee format / ieee rapor
- project documentation / proje raporu
- conference paper / paper yazma

## Inputs

Collect these inputs first:
- Requirement source file (PDF/markdown), if available: expected sections and mandatory content
- Target scope (full project, phase, or module)
- Output directory for `.tex` and `.bib` files
- Report language preference (default: English)
- Author name(s), affiliation (university/company/department), and contact info

## Section Structure

Section headings must be derived from the project requirement document when one exists. If no requirement document is provided, use the standard IEEE technical report structure below.

As a baseline, every report should include at minimum:

1. **Introduction** — project goal, scope, motivation
2. **Related Work** — prior art, relevant literature
3. **System Architecture and Methodology** — architecture, technology stack, data management
4. **[Project-specific sections]** — one section per major functional area or contribution
5. **Evaluation / Results** — test approach, metrics, results
6. **Conclusion and Future Work** — summary, completion status, future work

Do not remove required sections from the requirement document. Additional sections are allowed only if they do not hide mandatory items.

## Workflow

```text
Report Build Progress
- [ ] Step 1: Read requirement document
- [ ] Step 2: Analyze codebase for evidence (internal only)
- [ ] Step 3: Build requirement-to-section map
- [ ] Step 4: Write LaTeX report with academic prose
- [ ] Step 5: Create BibTeX references file
- [ ] Step 6: Insert figure placeholders
- [ ] Step 7: Run quality gate
```

### Step 1: Read Requirement Document (If Available)

- If a requirement document exists, parse it to identify mandatory sections, constraints, and deliverables.
- If no requirement document is provided, proceed with the standard IEEE section structure from the Section Structure baseline.
- If a previous report exists as reference (e.g., an MD file from a prior project), use it for style cues only — not content.

### Step 2: Analyze Codebase For Evidence (Internal Only)

- Read relevant source files to understand algorithms, architecture, data models, and behaviors.
- **CRITICAL**: This is an INTERNAL step. The facts extracted inform the report prose, but file paths, class names, function names, and code identifiers must NEVER appear in the final report text.
- For each requirement, understand the implementation approach conceptually (algorithm, data structure, strategy) and describe it in academic language.
- If code and requirement conflict, note the conflict before writing.

### Step 3: Build Requirement-To-Section Map

- Convert each requirement into a report section obligation.
- Attach evidence category: architecture decision, algorithm behavior, test result, or UI behavior.
- Mark each requirement: `covered`, `partial`, `missing`.
- Do not draft prose until all mandatory items are mapped.

### Step 4: Write LaTeX Report

- Use `\documentclass[conference]{IEEEtran}` with appropriate babel language package.
- Write purely in academic prose — ZERO code identifiers anywhere.
- Use IEEE `algorithm` environment with `algorithmic` for algorithmic flows.
- Use `booktabs` tables for parameters, thresholds, and feature summaries.
- Convert list-heavy prose into tables when the content is effectively a mapping, inventory, grouped configuration, or repeated option set.
- Keep narrative flow as prose when a small table would harm readability more than help it; use judgment rather than forcing every short list into a table.
- Do NOT cite the assignment PDF/MD as a source by default; cite only external technologies, papers, algorithms, standards, or data sources actually used by the project.
- Rewrite report explanations into independent academic narration instead of echoing the assignment document's phrasing or illustrative framing.
- Use `\cite{}` for all external references.

### Step 5: Create BibTeX References

- Create a `references.bib` file with entries for all cited technologies, algorithms, and data sources.
- Include framework documentation, algorithm papers, and data sources used in the project.

### Step 6: Insert Figure Placeholders

- Insert at least 3 figure placeholder entries using `\fbox{}` blocks.
- Each placeholder must include: label, caption, capture source, and expected content description.
- The author will replace placeholders with `\includegraphics` manually after capturing screenshots.

See: [reference/image-policy.md](reference/image-policy.md)

### Step 7: Run Quality Gate

See: [checklists/quality-gate.md](checklists/quality-gate.md)

## Writing Style Contract

- **Tone**: Formal, academic, IEEE conference paper level.
- **Language**: Match the user's language preference. English by default; use Turkish when explicitly requested. Foreign technical terms with no equivalent in the report language may be kept in English.
- **Granularity**: Explain architecture and algorithm decisions, not implementation details.
- **Vocabulary**: Use domain terms NOT code terms:

| Use (Domain Term) | Do NOT Use (Code Term) |
|---|---|
| algorithm | algorithm class |
| module | module file |
| layer | layer directory |
| mechanism | service |
| component | component class |
| data access layer | repository |
| core logic | controller |

- **Allowed in report**:
  - Pseudocode (IEEE `algorithm` environment)
  - Tables (parameters, thresholds, feature comparisons)
  - Architecture descriptions in prose
  - Figure placeholders with capture intent

- **Strictly forbidden in report body**:
  - File paths (e.g., `lib/src/...`)
  - Source code blocks or inline code
  - Class/function/variable names
  - Directory structure listings
  - Any `.dart`, `.json`, `.py`, `.ts`, `.yaml` file reference

The report reader should understand the system without ever seeing the codebase.

## Output Contract

Always produce:
1. LaTeX file (`.tex`) using IEEEtran conference class
2. BibTeX file (`.bib`) with all references
3. Build README explaining how to compile
4. At least 3 figure placeholders with capture intent
5. Minimum 4 pages in IEEE two-column format

## Templates and References

- [templates/report-template.tex](templates/report-template.tex) — LaTeX skeleton
- [templates/report-template.md](templates/report-template.md) — Markdown skeleton
- [templates/figure-placeholders.md](templates/figure-placeholders.md) — Figure placeholder format
- [checklists/quality-gate.md](checklists/quality-gate.md) — Final quality checklist
- [reference/image-policy.md](reference/image-policy.md) — Figure handling rules
- [reference/style-baseline.md](reference/style-baseline.md) — Academic style baseline
- [reference/requirements-mapping.md](reference/requirements-mapping.md) — Requirement mapping guide
- [reference/repo-evidence-sources.md](reference/repo-evidence-sources.md) — Evidence gathering guide

## Example

For a minimal example output outline, see:
- [examples/sample-filled-outline.md](examples/sample-filled-outline.md)
````

## File: README.md
size: 4806
sha: 469bb5805a218464b4afeec6ab3d976e47dc1096
upstream: https://github.com/enesdemir143/awesome-ieee-report/blob/HEAD/README.md

````text
# awesome-ieee-report

An AI agent skill that generates IEEE-format technical reports as LaTeX. Point it at your project, and it reads the codebase, maps requirements to sections, and produces a publication-ready `.tex` + `.bib` output with zero code artifacts in the report body.

---

## Features

- **Requirement-driven structure** — reads your requirement document and derives section headings from it; falls back to standard IEEE baseline when no document is provided
- **Zero code artifacts** — no file paths, class names, or function names in the report body; everything is described in academic prose
- **Pseudocode only** — core algorithms are expressed using the IEEE `algorithm` environment, never raw source code
- **Figure placeholders** — labeled `\fbox{}` placeholders with capture intent; you replace them with real screenshots manually
- **BibTeX output** — generates a `references.bib` alongside the `.tex` file
- **Quality gate** — built-in checklist that verifies every rule before the report is finalized
- **Language-agnostic** — English by default; Turkish (or any babel-supported language) on request

---

## Key Topics

- IEEE `IEEEtran` conference class
- Two-column academic layout
- `booktabs` tables for parameters, thresholds, and comparisons
- `algorithm` + `algorithmic` environments for pseudocode
- BibTeX / `\cite{}` reference management
- Figure placeholder workflow
- Requirement-to-section mapping

---

## How to Use

**1. Install the skill**

Clone this repository into your agent's skills directory:

```bash
# Claude Code
git clone https://github.com/EnesDemir143/awesome-ieee-report ~/.claude/skills/awesome-ieee-report

# OpenAI Codex CLI
git clone https://github.com/EnesDemir143/awesome-ieee-report ~/.codex/skills/awesome-ieee-report
```

**2. Invoke**

```
Write an IEEE technical report for this project.
```

With a requirement document:

```
Write an IEEE technical report based on requirements.pdf.
Report language: English
Author: Jane Doe, Computer Engineering, MIT
```

**3. Provide inputs when prompted**

| Input | Required | Default |
|---|---|---|
| Requirement document (PDF/MD) | No | Standard IEEE baseline |
| Target scope | Yes | — |
| Output directory | Yes | — |
| Report language | No | English |
| Author name & affiliation | Yes | — |

**4. Compile the output**

```bash
pdflatex report.tex
bibtex report
pdflatex report.tex
pdflatex report.tex
```

Or use `latexmk`:

```bash
latexmk -pdf report.tex
```

**5. Replace figure placeholders**

Find every `\fbox{...PLACEHOLDER...}` block and replace with:

```latex
\setlength{\fboxsep}{0pt}\fbox{\includegraphics[width=0.57\linewidth]{images/your-screenshot.png}}
```

---

## Repository Structure

```
latex-report-creator/
├── SKILL.md                          # Main skill definition
├── templates/
│   ├── report-template.tex           # LaTeX skeleton (IEEEtran)
│   ├── report-template.md            # Markdown skeleton
│   └── figure-placeholders.md        # Figure placeholder format
├── reference/
│   ├── style-baseline.md             # Academic writing style rules
│   ├── requirements-mapping.md       # Requirement → section mapping guide
│   ├── image-policy.md               # Figure handling rules
│   ├── repo-evidence-sources.md      # Evidence gathering guide
│   └── companion-skill-routing.md    # Companion skill routing table
├── checklists/
│   └── quality-gate.md               # Final quality checklist
└── examples/
    └── sample-filled-outline.md      # Example filled report outline
```

---

## Community & Feedback

Found a bug, have a suggestion, or want to contribute a template?

- **Issues** — open a [GitHub Issue](https://github.com/EnesDemir143/awesome-ieee-report/issues) for bug reports or feature requests
- **Discussions** — use [GitHub Discussions](https://github.com/EnesDemir143/awesome-ieee-report/discussions) for questions, ideas, and sharing reports you've generated
- **Pull Requests** — contributions are welcome; please keep changes focused and include a short description of what was changed and why

---

## Contributing

Contributions are welcome — see [CONTRIBUTING.md](CONTRIBUTING.md) for the full guide.

Quick summary:
- Fork → branch → commit → PR
- Keep changes focused and minimal
- Good targets: new example reports, checklist improvements, template variants, bug fixes in skill rules
- Do not add project-specific content (university names, course codes, etc.)

---

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=EnesDemir143/awesome-ieee-report&type=Date)](https://star-history.com/#EnesDemir143/awesome-ieee-report&Date)

---
## License

MIT
````

## File: .gitignore
size: 131
sha: 989959417fd3e8345642ba923eb2ac56a3bf3e76
upstream: https://github.com/enesdemir143/awesome-ieee-report/blob/HEAD/.gitignore

```text
# macOS
.DS_Store
.AppleDouble
.LSOverride

# LaTeX build artifacts
*.aux
*.log
*.out
*.toc
*.synctex.gz
*.fls
*.fdb_latexmk
*.pdf
```

## File: checklists/quality-gate.md
size: 2357
sha: aab224076451e6084bf4d163a087d8bd1c11b6e5
upstream: https://github.com/enesdemir143/awesome-ieee-report/blob/HEAD/checklists/quality-gate.md

```text
# Quality Gate Checklist

Run this loop before finalizing report outputs.

## Checklist

- [ ] Required sections are present and in order (from requirement document or standard IEEE baseline).
- [ ] **ZERO code artifacts**: No file paths, class names, function names, variable names, directory structures, or source file extensions anywhere in the report body.
- [ ] All technical claims describe systems, algorithms, and mechanisms in academic prose — not implementation code.
- [ ] Vocabulary uses domain terms (algorithm, module, layer, mechanism, component) NOT code terms (Controller, Repository, Widget, Service).
- [ ] At least 3 figure entries are present as labeled placeholders with capture intent.
- [ ] Each placeholder figure has: label, caption, and description of what should be captured.
- [ ] Core algorithmic flows use IEEE `algorithm` environment with pseudocode — no raw code blocks.
- [ ] All external references use `\cite{}` with matching BibTeX entries.
- [ ] Requirement/assignment document is used for coverage control only and is not automatically included in the bibliography.
- [ ] Report prose is an original academic synthesis and does not track the wording or framing of the assignment handout too closely.
- [ ] Dense enumerations and repeated option sets are reviewed for possible table conversion where this improves two-column readability.
- [ ] Large figures/tables are not stacked in a way that creates obvious white-space holes before the next subsection.
- [ ] Test/evaluation section describes tested BEHAVIORS, not test file names or commands.
- [ ] Report language matches the user's preference throughout.
- [ ] Report reads as a self-contained academic paper — understandable without seeing the codebase.
- [ ] Report is substantive enough to fill at least 4 pages in IEEE two-column format when compiled. (Verify after LaTeX compilation — cannot be confirmed from source alone.)

## Feedback Loop

1. Run checklist.
2. If any item fails, fix content.
3. Re-run checklist.
4. Finalize only when all items pass.

## Fast Failure Rules

Reject draft as incomplete if any condition is true:
- Any file path or code identifier appears in the report body
- Fewer than 3 figure placeholders
- Missing evaluation/results section
- Missing architecture/methodology section
- Raw source code block in any section
```

## File: CONTRIBUTING.md
size: 1034
sha: b535e106bbc041637392f05bce79a4f5a217879a
upstream: https://github.com/enesdemir143/awesome-ieee-report/blob/HEAD/CONTRIBUTING.md

```text
# Contributing

Contributions are welcome. Please keep changes focused and minimal.

## How to Contribute

1. Fork the repository
2. Create a branch: `git checkout -b fix/your-fix` or `feat/your-feature`
3. Make your changes
4. Commit with a clear message: `git commit -m "fix: describe what changed"`
5. Push and open a Pull Request

## What to Contribute

- Bug fixes in skill rules or templates
- New example reports (`examples/`)
- Improvements to the quality gate checklist
- Additional reference guides
- Template variants (e.g., journal format, extended abstract)

## What NOT to Contribute

- Project-specific content (university names, course codes, etc.)
- Changes that break the zero-code-artifact rule
- Hardcoded language assumptions

## License

By contributing, you agree that your contributions will be licensed under MIT License.

## Reporting Issues

Open a [GitHub Issue](https://github.com/EnesDemir143/awesome-ieee-report/issues) with:
- What you expected
- What actually happened
- Minimal example if applicable
```

## File: examples/sample-filled-outline.md
size: 5580
sha: 6b1a6b00a52b133cc311027a4cc2243a8d40275a
upstream: https://github.com/enesdemir143/awesome-ieee-report/blob/HEAD/examples/sample-filled-outline.md

````text
# Sample Filled Report Outline

> This example demonstrates the report structure following skill rules for a generic software project (a real-time task scheduling system). Note: No file paths, class names, or code references appear anywhere.

---

## 1) Abstract

This paper presents a real-time task scheduling system designed for distributed computing environments. The system employs a priority-based scheduling algorithm combined with a dynamic load-balancing mechanism to minimize task completion time and maximize resource utilization. Experimental results demonstrate a 34% reduction in average task latency compared to a round-robin baseline.

---

## 2) Keywords

task scheduling, distributed systems, load balancing, priority queue, real-time systems

---

## 3) Introduction

Efficient task scheduling is a fundamental challenge in distributed computing. As workloads grow in scale and heterogeneity, static scheduling strategies fail to adapt to runtime conditions. This work proposes a dynamic scheduling mechanism that combines priority-based queuing with real-time load monitoring.

The remainder of this report is organized as follows: Section II reviews related work, Section III describes the system architecture, Section IV details the scheduling algorithm, Section V presents evaluation results, and Section VI concludes the paper.

---

## 4) Related Work

Early scheduling approaches relied on static assignment strategies [1]. More recent work has explored adaptive mechanisms that respond to runtime load signals [2]. Unlike prior systems, the proposed approach integrates both priority and load state into a unified scheduling decision without requiring a centralized coordinator.

---

## 5) System Architecture and Methodology

### Overall Architecture

The system is organized into three layers: a task ingestion layer responsible for receiving and validating incoming tasks, a scheduling core that applies the priority and load-balancing logic, and a worker management layer that dispatches tasks to available execution units.

[PLACEHOLDER — ARCHITECTURE DIAGRAM]
*Capture: System architecture overview showing the three layers and data flow between components.*

### Technology Stack

The system is implemented using a compiled, statically typed language chosen for its low-latency runtime characteristics [3]. Persistent task state is maintained in a lightweight embedded key-value store [4].

### Data Management Strategy

Task metadata is stored in a persistent queue structure. Each task record contains a priority score, submission timestamp, estimated duration, and current status. The scheduling core reads and updates task state atomically to prevent race conditions under concurrent access.

---

## 6) Scheduling Algorithm

### Priority Scoring

Each incoming task is assigned a composite priority score computed from its declared urgency level and its waiting time in the queue. Tasks that have waited beyond a configurable threshold receive a priority boost to prevent starvation.

**Algorithm 1 — Priority Score Computation**
```
Input: task t, current time T
1. base_score ← t.urgency_level × weight_urgency
2. wait_time ← T − t.submission_time
3. IF wait_time > starvation_threshold THEN
4.     boost ← (wait_time − starvation_threshold) × boost_rate
5. ELSE
6.     boost ← 0
7. RETURN base_score + boost
```

### Load Balancing

Before dispatching a task, the scheduler queries the current load of each available worker. The task is assigned to the worker with the lowest load score. If all workers exceed a high-load threshold, the task is held in the queue until a worker becomes available.

| Parameter | Default Value | Description |
|---|---|---|
| weight_urgency | 0.7 | Weight applied to urgency level in priority score |
| starvation_threshold | 30 s | Wait time after which priority boost activates |
| boost_rate | 0.05 / s | Priority increase per second beyond threshold |
| high_load_threshold | 0.85 | Worker load fraction above which dispatch is deferred |

---

## 7) Evaluation

The system was evaluated against a round-robin baseline using a synthetic workload of 10,000 tasks with varying urgency levels and durations. Key metrics measured: average task latency, maximum task latency, and worker utilization variance.

| Metric | Round-Robin | Proposed System | Improvement |
|---|---|---|---|
| Avg. task latency | 412 ms | 271 ms | −34% |
| Max. task latency | 2,840 ms | 1,190 ms | −58% |
| Worker utilization variance | 0.18 | 0.06 | −67% |

[PLACEHOLDER — LATENCY DISTRIBUTION CHART]
*Capture: Bar or box plot comparing latency distributions between round-robin and proposed system.*

[PLACEHOLDER — WORKER UTILIZATION OVER TIME]
*Capture: Time-series chart showing per-worker load during the evaluation run.*

---

## 8) Conclusion and Future Work

The proposed scheduling system achieves significant latency and utilization improvements over a round-robin baseline. The priority boost mechanism effectively prevents task starvation without sacrificing throughput.

Future work includes extending the load-balancing mechanism to account for task duration estimates, and evaluating the system under real-world heterogeneous workloads.

---

## 9) References

[1] A. Author, "Static Task Scheduling in Distributed Systems," *IEEE Trans. Parallel Distrib. Syst.*, vol. 12, no. 3, pp. 210–225, 2001.
[2] B. Author and C. Author, "Adaptive Load Balancing for Cloud Workloads," in *Proc. IEEE CLOUD*, 2018, pp. 45–52.
[3] [Runtime/language reference]
[4] [Key-value store reference]
````

## File: LICENSE
size: 1067
sha: 67897e579aa8226d6120ee2b3a8729cf6e029c67
upstream: https://github.com/enesdemir143/awesome-ieee-report/blob/HEAD/LICENSE

```text
MIT License

Copyright (c) 2026 Enes Demir

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```

## File: reference/companion-skill-routing.md
size: 966
sha: 0bdb7f2db7968ca4065f39b90caf1180894f4ad0
upstream: https://github.com/enesdemir143/awesome-ieee-report/blob/HEAD/reference/companion-skill-routing.md

```text
# Companion Skill Routing

## Purpose

Define when `latex-report-creator` should pull additional constraints from other skills.

## Routing Table

| Signal In User Request | Companion Skill | What To Import |
| --- | --- | --- |
| `ieee`, `IEEE`, `ieee citation`, `citation conversion` | `academic-paper` (`../academic-paper/SKILL.md`) | Citation-format expectations and academic compliance checks |
| `ieee template`, `conference template`, `journal template`, `venue format` | `venue-templates` (`../venue-templates/SKILL.md`) | Venue-specific LaTeX template and layout constraints |

## Merge Rules

1. User requirement document has highest priority.
2. Companion skill constraints are applied next.
3. Sample PDF style is visual guidance only.

## Output Notes

When companion skills are used:
- Add a short note in report metadata describing which companion constraints were applied.
- Keep markdown and LaTeX outputs aligned to the same selected format rules.
```

## File: reference/image-policy.md
size: 1993
sha: 66f9bcbc2f45a43338db0657049824671df33417
upstream: https://github.com/enesdemir143/awesome-ieee-report/blob/HEAD/reference/image-policy.md

````text
# Image Policy

## Goal

Define figure handling rules that ensure every report includes meaningful visual content while keeping figures as author-managed placeholders.

## Decision Flow

1. Every report MUST include at least 3 figure entries.
2. All figures are inserted as labeled placeholders with capture intent.
3. Real images are added MANUALLY by the author after report generation.
4. Never generate, embed, or pretend images are real captures.

## Required Figure Set (Default)

Every report should include placeholder entries for at minimum:
- System architecture overview diagram
- At least 2 key result or UI screen captures
- Additional figures as needed by the project scope

## Placeholder Format (LaTeX)

```latex
\begin{figure}[H]
  \centering
  \fbox{\parbox{0.9\linewidth}{
    \centering
    \textbf{[PLACEHOLDER --- DESCRIPTION]}\\[0.5em]
    \small Source: [where this will be captured from]\\
    Expected content: [content description]
  }}
  \caption{[Figure caption]}
  \label{fig:label}
\end{figure}
```

## Replacement Instructions

When replacing placeholders with real images:

```latex
\begin{figure}[H]
  \centering
  \setlength{\fboxsep}{0pt}\fbox{\includegraphics[width=0.57\linewidth]{images/screenshot.png}}
  \caption{[Figure caption]}
  \label{fig:label}
\end{figure}
```

Recommended post-replacement practice for IEEE two-column layouts:
- UI screenshots often read better around `0.55\linewidth` to `0.60\linewidth` than near full width.
- A thin black frame (`\fbox` with `\fboxsep=0pt`) helps screenshots stand apart from light report backgrounds.
- If several screenshots are nearby, avoid forcing all of them into the same local area; distribute them between adjacent subsections to reduce visible white-space gaps.

## Consistency Rules

- Same figure IDs and captions in both markdown and LaTeX outputs.
- Each placeholder must define: capture target, source, and expected content.
- Never drop the figure section even if no images are available.
````

## File: reference/repo-evidence-sources.md
size: 1489
sha: d464907b6151889f1d75fc27ac89d9ddd39ee6fd
upstream: https://github.com/enesdemir143/awesome-ieee-report/blob/HEAD/reference/repo-evidence-sources.md

```text
# Repository Evidence Sources

## Purpose

Identify where to gather facts about the system during report preparation.
These facts inform the report prose but MUST NOT appear as file paths or code identifiers in the final report.

## Evidence Gathering (INTERNAL ONLY)

Evidence gathering is an internal-only step. The agent reads code files to understand:
- What algorithms are used
- What data structures are employed
- What architectural decisions were made
- What behaviors are implemented
- What test coverage exists

These facts are then described in academic language in the report body.

## Evidence Categories

- **Architecture evidence**: Understand the layer structure, component responsibilities, and data flow
- **Algorithm evidence**: Understand the specific algorithms (DFS, Trie, weighted random, etc.)
- **Data model evidence**: Understand the database schema, table relationships, and persistence strategy
- **UI evidence**: Understand the screen flows, interaction patterns, and visual design
- **Test evidence**: Understand what behaviors are tested and what the results are

## Evidence Quality Levels

- Level A: Direct understanding of algorithm/architecture from code reading
- Level B: Test behavior verification from test files
- Level C: Planning docs and narrative summaries

Prefer A + B. Use C only as support.

## CRITICAL RULE

Evidence informs writing but NEVER appears in the report. The report describes WHAT and HOW in academic prose, not WHERE in code.
```

## File: reference/requirements-mapping.md
size: 2286
sha: 37b5700cb45cdfff6c2ad19bea2f99c0b62fea61
upstream: https://github.com/enesdemir143/awesome-ieee-report/blob/HEAD/reference/requirements-mapping.md

```text
# Requirements Mapping Guide

## Purpose

Translate requirement documents (when available) into report sections that can be verified from repository artifacts.

## Mapping Process

1. Extract mandatory headings and explicit constraints from the requirement document.
2. Convert each requirement into a report obligation.
3. Assign an evidence category and acceptance check.
4. If no requirement document exists, use the standard IEEE section structure as the baseline.

## Requirement To Report Matrix

| Requirement Type | Report Section | Evidence Category | Acceptance Check |
| --- | --- | --- | --- |
| Project goal/scope | Introduction | Architecture understanding | Scope text matches requirement intent |
| Prior art / literature | Related Work | Literature review | Relevant prior work cited and compared |
| Architecture/design | System Architecture and Methodology | Layer and component analysis | Architecture and data flow are explained |
| Core mechanisms | Project-specific sections | Algorithm and behavior analysis | Algorithms described in pseudocode/prose |
| UI/interaction | Project-specific or Evaluation section | Screen flow understanding | UI described with figure placeholders |
| Testing/validation | Evaluation | Test behavior analysis | Tested behaviors listed with results |
| Limitations/future | Conclusion and Future Work | Completion status assessment | Real status statements, not filler |

## Mandatory Writing Rules

- Every non-trivial claim must be backed by understanding of the actual implementation.
- The claim itself must be written in academic prose — NO file paths, class names, or code references.
- Keep terminology consistent across all report sections.

## Requirement Document Parsing Notes

When a requirement source is provided (PDF or Markdown):
- Parse text and list required section names in order.
- Detect explicit figure/table requirements.
- Record formatting constraints (title page, numbering, bibliography style) if present.

If parsing is blocked:
- Request extracted text content from user.
- Continue with available structured requirements.

When no requirement document is provided:
- Use the standard IEEE section structure from SKILL.md as the baseline.
- Derive sections from the project's major functional areas.
```

## File: reference/style-baseline.md
size: 1454
sha: 7778774f0794adc9a1b5fd203c2b78acc1819a76
upstream: https://github.com/enesdemir143/awesome-ieee-report/blob/HEAD/reference/style-baseline.md

```text
# Style Baseline

## Purpose

Define the academic writing style for IEEE technical reports.

## Style Source

Derived from IEEE conference paper conventions and standard academic writing practices.

## What To Apply

- IEEE conference paper format (`\documentclass[conference]{IEEEtran}`)
- Report language as specified by the user (default: English)
- Section hierarchy: `\section{}` and `\subsection{}`
- IEEE `algorithm` environment for pseudocode
- `\cite{}` references with BibTeX
- Placeholder figures using `\fbox{}` blocks
- Tables using `booktabs` style (`\toprule`, `\midrule`, `\bottomrule`)

## Heading Style

- Main sections: Roman numeral style (I. INTRODUCTION, II. RELATED WORK...)
- Subsections: Lettered style (A. Subsection, B. Subsection...)
- IEEEtran class handles this automatically

## Vocabulary Rules

Use domain-level terms, not implementation-level identifiers:

| Use (Domain Term) | Do NOT Use (Code Term) |
|---|---|
| algorithm | algorithm class |
| module | module file |
| layer | layer directory |
| mechanism | service |
| component | component class |
| data access layer | repository |
| user interface layer | widget tree / view controller |
| core logic | controller |
| local database | sqlite instance |
| configuration | .json / .yaml file |

## Practical Rule

Every paragraph in the final output must be understandable by a reader who has never seen the codebase. No implementation-level identifiers allowed.
```

## File: templates/figure-placeholders.md
size: 1998
sha: 119b021be61549b7557b2fe39945153dd7aea2d3
upstream: https://github.com/enesdemir143/awesome-ieee-report/blob/HEAD/templates/figure-placeholders.md

````text
# Figure Placeholders Template

## Rules

1. Every report must include at least 3 figure placeholders.
2. Figures are NEVER generated or embedded — only placeholders are created.
3. Real images are added manually by the author after report generation.
4. Each placeholder must specify: ID, caption, capture target, and expected content.

## Standard Placeholder Set

### FIG-01: Architecture Diagram

| Field | Value |
|---|---|
| ID | fig:architecture |
| Caption | Overall system architecture |
| Source | To be drawn by the author or exported from a diagram tool |
| Content | Layered architecture: UI → Core Logic → Data Access |

### FIG-02: Main Screen / Primary Result

| Field | Value |
|---|---|
| ID | fig:main_screen |
| Caption | [Main screen or primary result view of the project] |
| Source | Screenshot from emulator, device, or application |
| Content | [Description of what the main functional screen shows] |

### FIG-03: Secondary Screen / Result 1

| Field | Value |
|---|---|
| ID | fig:screen_2 |
| Caption | [Secondary screen or result view] |
| Source | Screenshot from emulator, device, or application |
| Content | [Description of the relevant screen or result] |

### FIG-04: Secondary Screen / Result 2

| Field | Value |
|---|---|
| ID | fig:screen_3 |
| Caption | [Third screen or result view] |
| Source | Screenshot from emulator, device, or application |
| Content | [Description of the relevant screen or result] |

## LaTeX Placeholder Format

```latex
\begin{figure}[H]
  \centering
  \fbox{\parbox{0.9\linewidth}{
    \centering
    \textbf{[PLACEHOLDER --- DESCRIPTION]}\\[0.5em]
    \small Source: [source description]\\
    Expected content: [content description]
  }}
  \caption{[Caption]}
  \label{fig:label}
\end{figure}
```

## Replacing with Real Image

```latex
\begin{figure}[H]
  \centering
  \setlength{\fboxsep}{0pt}\fbox{\includegraphics[width=0.57\linewidth]{images/filename.png}}
  \caption{[Caption]}
  \label{fig:label}
\end{figure}
```
````

## File: templates/report-template.md
size: 2151
sha: 18dccb09059966700ae6a81bcd30a3a521c8bc82
upstream: https://github.com/enesdemir143/awesome-ieee-report/blob/HEAD/templates/report-template.md

```text
# [Project Title] — IEEE Technical Report

> Writing rule: No file paths, class names, function names, or any code references may appear in the report body. All technical explanations must be written in academic language at the algorithm and mechanism level.

## 1) Abstract

[Summary of the project's goal, approach, methods used, and key results.]

## 2) Keywords

[keyword 1], [keyword 2], [keyword 3], ...

## 3) Introduction

- Project motivation and goal
- Introduction to the relevant domain
- Core technologies used (academic language, with references)
- Overview of the report structure

## 4) Related Work

- Prior work and relevant literature
- How this project relates to or differs from existing approaches

## 5) System Architecture and Methodology

### Overall Architecture

- Layered architecture description (UI, core logic, data access)
- Separation of responsibilities between layers
- Architecture diagram (placeholder or real)

### Technology Stack

- Frameworks, languages, databases, and libraries used
- Rationale for each choice

### Data Management Strategy

- Persistent storage approach
- Database schema design (conceptual level — without table names)
- Data access layer architecture

## 6) [Project-Specific Sections]

> These sections are derived from the project requirement document or major functional areas.
> Create a separate subsection for each major functional area.
> Algorithms are given as pseudocode.
> Parameters and thresholds are presented in a table.

## 7) Evaluation

- Test approach (unit test, component test, integration test)
- Tested behaviors (not file names or commands)
- Results summary
- Performance metrics if applicable

## 8) Conclusion and Future Work

- Current completion status
- Requirement coverage summary
- Future development steps

## 9) Acknowledgment

[Course, institution, or funding acknowledgment if applicable.]

## 10) References

[BibTeX references]

> Note: The requirement/assignment document may be used to determine report scope and section headings, but is not added to the bibliography by default. Report text must be written as independent academic narration.
```

## File: templates/report-template.tex
size: 4427
sha: aeff3c248ac8bbf492289eaf1c27d34437145a21
upstream: https://github.com/enesdemir143/awesome-ieee-report/blob/HEAD/templates/report-template.tex

```text
\documentclass[conference]{IEEEtran}
�sepackage[utf8]{inputenc}
�sepackage[T1]{fontenc}
% Set babel language to match report language (e.g. english, turkish, german)
�sepackage[english]{babel}
�sepackage{cite}
�sepackage{amsmath,amssymb,amsfonts}
�sepackage{algorithmic}
�sepackage{algorithm}
�sepackage{graphicx}
�sepackage{textcomp}
�sepackage{xcolor}
�sepackage{hyperref}
�sepackage{booktabs}
�sepackage{float}

\hypersetup{
  colorlinks=true,
  linkcolor=blue,
  citecolor=blue,
  urlcolor=blue
}

\begin{document}

\title{[PROJECT TITLE]: [Short Description]}

\author{
\IEEEauthorblockN{[Author Name]}
\IEEEauthorblockA{
[Department] \\
[University / Organization] \\
[City, Country] \\
[Email or ID]}
}

\maketitle

\begin{abstract}
[Summary of the project's goal, approach, methods used, and key results.
Must be written in purely academic language with no code references.]
\end{abstract}

\begin{IEEEkeywords}
[keyword 1], [keyword 2], [keyword 3], ...
\end{IEEEkeywords}

% ================================================================
\section{Introduction}
% ================================================================

[Project motivation, goal, and scope.
Introduction to the relevant domain and the project's position within it.
Core technologies and approaches used (in academic language).
Overview of the rest of the report.]

% ================================================================
\section{Related Work}
% ================================================================

[Prior work, relevant literature, and how this project relates to or differs from existing approaches.
Use \cite{} for all references.]

% ================================================================
\section{System Architecture and Methodology}
% ================================================================

\subsection{Overall Architecture}

[Layered architecture description.
Separation of responsibilities between layers.
Reference to architecture diagram.]

\begin{figure}[H]
  \centering
  \fbox{\parbox{0.9\linewidth}{
    \centering
    \textbf{[PLACEHOLDER --- ARCHITECTURE DIAGRAM]}\\[0.5em]
    \small [Description of what should be shown]
  }}
  \caption{[Figure caption]}
  \label{fig:architecture}
\end{figure}

\subsection{Technology Stack}

[Technologies used and rationale for each choice.
Use \cite{} for each technology reference.]

\subsection{Data Management Strategy}

[Persistent storage approach.
Database schema and table structures (conceptual level).
Data access layer architecture.]

% ================================================================
% [PROJECT-SPECIFIC SECTIONS]
% Sections below are derived from the project requirement document
% or the major functional areas of the system.
% ================================================================

\section{[Project-Specific Section 1]}

[Description of the relevant mechanism or module.
Use IEEE algorithm environment for pseudocode if applicable.
Present parameters and thresholds in a table.]

\begin{algorithm}[H]
\caption{[Algorithm Name]}
\begin{algorithmic}[1]
\STATE [Step 1]
\STATE [Step 2]
\IF{[condition]}
  \STATE [action]
\ENDIF
\RETURN [result]
\end{algorithmic}
\end{algorithm}

\section{[Project-Specific Section 2]}
[...]

% ================================================================
\section{Evaluation}
% ================================================================

[Test approach and coverage areas.
Unit, component, and integration test results.
Performance metrics and analysis.
Summary of tested behaviors — not test file names or commands.]

\begin{figure}[H]
  \centering
  \fbox{\parbox{0.9\linewidth}{
    \centering
    \textbf{[PLACEHOLDER --- RESULT / SCREENSHOT]}\\[0.5em]
    \small Source: [where this will be captured from]\\
    [Description of expected content]
  }}
  \caption{[Figure caption]}
  \label{fig:result_1}
\end{figure}

% ================================================================
\section{Conclusion and Future Work}
% ================================================================

[Current completion status of the project.
Requirement coverage summary (table optional).
Future development steps.]

% ================================================================
\section*{Acknowledgment}
[Course, institution, or funding acknowledgment if applicable.]

\bibliographystyle{IEEEtran}
\bibliography{references}

\end{document}
```
