{"id":"c6b5194b-b859-4037-8947-d4aacf149805","shortId":"RGR6s5","kind":"skill","title":"awesome-ieee-report","tagline":"Generates IEEE-format LaTeX technical reports from project requirements and codebase evidence, using academic prose, pseudocode-only explanations, BibTeX references, and IEEEtran formatting.","description":"# LaTeX Technical Report Creator\n\nCreates 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.\n\n## Non-Negotiable Rules\n\nApply these rules on every run unless the user explicitly overrides them:\n\n1. **Language**: Report body language follows the user's preference (default: English). Turkish is used when the user explicitly requests it.\n2. **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.\n3. **No source code dump**: Do not paste project source code blocks into the report.\n4. **Pseudocode only**: Include algorithm-level pseudocode (IEEE `algorithm` environment) for core flows instead of raw implementation code.\n5. **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.\n6. **Consistency gate**: Report statements must be checked against actual code before finalizing.\n7. **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.\n8. **Minimum 3 figures**: Every report must include at least 3 figure placeholder entries with capture intent description.\n9. **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).\n10. **IEEE format**: Use `\\documentclass[conference]{IEEEtran}`, minimum 4 pages in two-column format.\n11. **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.\n12. **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.\n13. **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.\n14. **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.\n\nIf any rule conflicts with user instruction, follow the user instruction and explicitly note the override.\n\n## When To Use\n\nUse this skill when requests include terms like:\n- technical report / teknik rapor\n- latex report\n- ieee format / ieee rapor\n- project documentation / proje raporu\n- conference paper / paper yazma\n\n## Inputs\n\nCollect these inputs first:\n- Requirement source file (PDF/markdown), if available: expected sections and mandatory content\n- Target scope (full project, phase, or module)\n- Output directory for `.tex` and `.bib` files\n- Report language preference (default: English)\n- Author name(s), affiliation (university/company/department), and contact info\n\n## Section Structure\n\nSection 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.\n\nAs a baseline, every report should include at minimum:\n\n1. **Introduction** — project goal, scope, motivation\n2. **Related Work** — prior art, relevant literature\n3. **System Architecture and Methodology** — architecture, technology stack, data management\n4. **[Project-specific sections]** — one section per major functional area or contribution\n5. **Evaluation / Results** — test approach, metrics, results\n6. **Conclusion and Future Work** — summary, completion status, future work\n\nDo not remove required sections from the requirement document. Additional sections are allowed only if they do not hide mandatory items.\n\n## Workflow\n\n```text\nReport Build Progress\n- [ ] Step 1: Read requirement document\n- [ ] Step 2: Analyze codebase for evidence (internal only)\n- [ ] Step 3: Build requirement-to-section map\n- [ ] Step 4: Write LaTeX report with academic prose\n- [ ] Step 5: Create BibTeX references file\n- [ ] Step 6: Insert figure placeholders\n- [ ] Step 7: Run quality gate\n```\n\n### Step 1: Read Requirement Document (If Available)\n\n- If a requirement document exists, parse it to identify mandatory sections, constraints, and deliverables.\n- If no requirement document is provided, proceed with the standard IEEE section structure from the Section Structure baseline.\n- If a previous report exists as reference (e.g., an MD file from a prior project), use it for style cues only — not content.\n\n### Step 2: Analyze Codebase For Evidence (Internal Only)\n\n- Read relevant source files to understand algorithms, architecture, data models, and behaviors.\n- **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.\n- For each requirement, understand the implementation approach conceptually (algorithm, data structure, strategy) and describe it in academic language.\n- If code and requirement conflict, note the conflict before writing.\n\n### Step 3: Build Requirement-To-Section Map\n\n- Convert each requirement into a report section obligation.\n- Attach evidence category: architecture decision, algorithm behavior, test result, or UI behavior.\n- Mark each requirement: `covered`, `partial`, `missing`.\n- Do not draft prose until all mandatory items are mapped.\n\n### Step 4: Write LaTeX Report\n\n- Use `\\documentclass[conference]{IEEEtran}` with appropriate babel language package.\n- Write purely in academic prose — ZERO code identifiers anywhere.\n- Use IEEE `algorithm` environment with `algorithmic` for algorithmic flows.\n- Use `booktabs` tables for parameters, thresholds, and feature summaries.\n- Convert list-heavy prose into tables when the content is effectively a mapping, inventory, grouped configuration, or repeated option set.\n- 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.\n- 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.\n- Rewrite report explanations into independent academic narration instead of echoing the assignment document's phrasing or illustrative framing.\n- Use `\\cite{}` for all external references.\n\n### Step 5: Create BibTeX References\n\n- Create a `references.bib` file with entries for all cited technologies, algorithms, and data sources.\n- Include framework documentation, algorithm papers, and data sources used in the project.\n\n### Step 6: Insert Figure Placeholders\n\n- Insert at least 3 figure placeholder entries using `\\fbox{}` blocks.\n- Each placeholder must include: label, caption, capture source, and expected content description.\n- The author will replace placeholders with `\\includegraphics` manually after capturing screenshots.\n\nSee: [reference/image-policy.md](reference/image-policy.md)\n\n### Step 7: Run Quality Gate\n\nSee: [checklists/quality-gate.md](checklists/quality-gate.md)\n\n## Writing Style Contract\n\n- **Tone**: Formal, academic, IEEE conference paper level.\n- **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.\n- **Granularity**: Explain architecture and algorithm decisions, not implementation details.\n- **Vocabulary**: Use domain terms NOT code terms:\n\n| Use (Domain Term) | Do NOT Use (Code Term) |\n|---|---|\n| algorithm | algorithm class |\n| module | module file |\n| layer | layer directory |\n| mechanism | service |\n| component | component class |\n| data access layer | repository |\n| core logic | controller |\n\n- **Allowed in report**:\n  - Pseudocode (IEEE `algorithm` environment)\n  - Tables (parameters, thresholds, feature comparisons)\n  - Architecture descriptions in prose\n  - Figure placeholders with capture intent\n\n- **Strictly forbidden in report body**:\n  - File paths (e.g., `lib/src/...`)\n  - Source code blocks or inline code\n  - Class/function/variable names\n  - Directory structure listings\n  - Any `.dart`, `.json`, `.py`, `.ts`, `.yaml` file reference\n\nThe report reader should understand the system without ever seeing the codebase.\n\n## Output Contract\n\nAlways produce:\n1. LaTeX file (`.tex`) using IEEEtran conference class\n2. BibTeX file (`.bib`) with all references\n3. Build README explaining how to compile\n4. At least 3 figure placeholders with capture intent\n5. Minimum 4 pages in IEEE two-column format\n\n## Templates and References\n\n- [templates/report-template.tex](templates/report-template.tex) — LaTeX skeleton\n- [templates/report-template.md](templates/report-template.md) — Markdown skeleton\n- [templates/figure-placeholders.md](templates/figure-placeholders.md) — Figure placeholder format\n- [checklists/quality-gate.md](checklists/quality-gate.md) — Final quality checklist\n- [reference/image-policy.md](reference/image-policy.md) — Figure handling rules\n- [reference/style-baseline.md](reference/style-baseline.md) — Academic style baseline\n- [reference/requirements-mapping.md](reference/requirements-mapping.md) — Requirement mapping guide\n- [reference/repo-evidence-sources.md](reference/repo-evidence-sources.md) — Evidence gathering guide\n\n## Example\n\nFor a minimal example output outline, see:\n- [examples/sample-filled-outline.md](examples/sample-filled-outline.md)","tags":["awesome","ieee","report","enesdemir143","academic-writing","agent-skill","agent-skills","ai-agent-skill","bibtex","claude-skills","codex-skills","ieeeetran"],"capabilities":["skill","source-enesdemir143","skill-awesome-ieee-report","topic-academic-writing","topic-agent-skill","topic-agent-skills","topic-ai-agent-skill","topic-bibtex","topic-claude-skills","topic-codex-skills","topic-ieee","topic-ieeeetran","topic-latex","topic-report-generator","topic-skill-md"],"categories":["awesome-ieee-report"],"synonyms":[],"warnings":[],"endpointUrl":"https://skills.sh/EnesDemir143/awesome-ieee-report","protocol":"skill","transport":"skills-sh","auth":{"type":"none","details":{"cli":"npx skills add EnesDemir143/awesome-ieee-report","source_repo":"https://github.com/EnesDemir143/awesome-ieee-report","install_from":"skills.sh"}},"qualityScore":"0.453","qualityRationale":"deterministic score 0.45 from registry signals: · indexed on github topic:agent-skills · 6 github stars · SKILL.md body (10,333 chars)","verified":false,"liveness":"unknown","lastLivenessCheck":null,"agentReviews":{"count":0,"score_avg":null,"cost_usd_avg":null,"success_rate":null,"latency_p50_ms":null,"narrative_summary":null,"summary_updated_at":null},"enrichmentModel":"deterministic:skill-github:v1","enrichmentVersion":1,"enrichedAt":"2026-05-18T19:14:25.447Z","embedding":null,"createdAt":"2026-05-18T13:22:12.359Z","updatedAt":"2026-05-18T19:14:25.447Z","lastSeenAt":"2026-05-18T19:14:25.447Z","tsv":"'1':87,600,680,725,1278 '10':328 '11':343 '12':376 '13':403 '14':436 '2':108,606,685,787,1286 '3':141,274,282,613,693,866,1087,1293,1303 '4':156,336,623,701,910,1300,1311 '5':175,636,709,1049,1309 '6':203,643,715,1080 '7':216,720,1121 '8':272 '9':290 'academ':19,65,255,291,378,387,706,853,926,1029,1133,1347 'access':1207 'across':468 'actual':198,212,1019 'ad':189 'addit':662 'adjac':469 'affili':557 'algorithm':161,165,315,800,845,886,934,937,939,1014,1063,1070,1172,1192,1193,1218 'algorithm-level':160 'allow':665,1213 'alway':1276 'analyz':56,686,788 'anywher':931 'apart':465 'appear':364,831 'appli':75 'approach':640,843 'appropri':919 'architectur':615,618,801,884,1170,1225 'area':452,633 'art':610 'artifact':219 'ask':373 'assign':344,1002,1035 'attach':881 'author':193,554,1107 'automat':363 'avail':55,113,529,730 'avoid':439 'awesom':2 'awesome-ieee-report':1 'babel':920 'back':445,447 'back-to-back':444 'baselin':140,593,762,1349 'behavior':805,887,892 'bib':547,1289 'bibliographi':349,368 'bibtex':25,711,1051,1287 'block':152,471,1093,1245 'bodi':90,222,1238 'booktab':426,942 'build':677,694,867,1294 'caption':1099 'captur':287,1100,1115,1232,1307 'categori':883 'check':210 'checklist':1339 'checklists/quality-gate.md':1126,1127,1335,1336 'cite':1000,1009,1043,1061 'class':232,822,1194,1205,1285 'class/function/variable':1249 'code':69,144,151,174,213,218,270,310,827,856,929,1182,1190,1244,1248 'codebas':16,58,687,789,1273 'collect':520 'column':341,434,1317 'compact':425 'comparison':1224 'compil':1299 'complet':649 'compon':319,1203,1204 'compress':407 'conceptu':266,844 'conclus':644 'confer':300,333,515,916,1135,1284 'configur':966 'conflict':477,859,862 'consist':204 'constraint':742 'contact':560 'content':534,785,959,1104 'contract':1130,1275 'contribut':635 'control':325,1212 'conveni':127 'convert':423,873,950 'core':168,1210 'cover':896 'coverag':117,357 'creat':34,455,710,1050,1053 'creator':33 'critic':806 'cue':782 'dart':227,1255 'data':621,802,846,1017,1065,1073,1206 'decis':885,1173 'default':97,352,552,1008,1147 'defin':356 'deliver':744 'deriv':568 'describ':257,850 'descript':289,1105,1226 'detail':1176 'directori':238,543,1200,1251 'distribut':466 'document':53,124,131,256,345,355,512,573,580,661,683,728,734,748,1036,1069 'documentclass':332,915 'domain':313,1179,1185 'draft':901 'driven':119 'dump':145 'e.g':770,1241 'echo':1033 'effect':961 'emb':197 'engin':44 'english':98,553,1145,1167 'entri':285,1058,1090 'enumer':394,409 'environ':166,935,1219 'equival':1158 'etc':231 'evalu':637 'ever':1270 'everi':79,276,594,992 'evid':17,60,384,689,791,882,1357 'exampl':397,1360,1364 'examples/sample-filled-outline.md':1368,1369 'execut':202 'exist':132,576,735,767 'expect':530,1103 'explain':1169,1296 'explan':24,1026 'explicit':84,105,372,486,1151 'extern':1011,1046 'extract':814 'fact':813 'fbox':1092 'featur':948,1223 'figur':176,180,275,283,717,1082,1088,1229,1304,1332,1342 'file':225,526,548,713,773,797,820,1056,1197,1239,1260,1280,1288 'final':215,367,834,1337 'first':111,306,406,523 'first-person':305 'float':437,467 'flow':169,940,973 'follow':92,481 'forbidden':1235 'forc':991 'foreign':1153 'formal':1132 'format':8,29,37,330,342,508,1318,1334 'frame':398,1041 'framework':1068 'full':537 'function':234,632,824 'futur':646,651 'gate':205,723,1124 'gather':1358 'generat':5,195 'goal':603 'granular':1168 'group':417,965 'guid':1354,1359 'handl':1343 'handout':402 'harm':981 'head':115,565 'heavi':953 'help':985 'hide':671 'hole':460 'hygien':438 'identifi':245,739,828,930 'ieee':3,7,36,136,164,299,329,431,507,509,586,755,933,1134,1217,1314 'ieee-format':6,35 'ieeetran':28,334,917,1283 'illustr':1040 'imag':199 'implement':173,243,322,842,1175 'implementation-level':242 'improv':430 'includ':159,224,279,498,597,1067,1097 'includegraph':1112 'independ':377,1028 'info':561 'inform':302,815 'inlin':1247 'input':519,522 'insert':182,716,1081,1084 'instead':170,320,1031 'instruct':480,484 'intent':288,1233,1308 'intern':690,792,810 'introduct':601 'inventori':414,964 'item':673,906 'jargon':311 'json':230,1256 'judgment':988 'keep':971 'kept':1165 'label':184,1098 'languag':88,91,303,550,854,921,1138,1143,1162 'larg':442 'latex':9,30,38,505,703,912,1279,1324 'layer':317,1198,1199,1208 'least':281,1086,1302 'level':162,244,1137 'lib/src':1242 'like':500 'list':952,994,1253 'list-heavi':951 'literatur':612 'live':271 'local':451 'logic':1211 'long':408 'major':631 'manag':622 'mandatori':533,672,740,905 'manual':190,1113 'map':413,699,872,908,963,1353 'mark':893 'markdown':1328 'match':1139 'may':1163 'md':772 'mechan':318,1201 'methodolog':617 'metric':419,641 'minim':1363 'minimum':273,335,599,1310 'miss':898 'model':803 'modul':316,541,1195,1196 'motiv':605 'must':208,278,382,566,829,1096 'name':233,235,237,555,823,825,1250 'narrat':379,470,972,1030 'need':473 'negoti':73 'never':194,223,830 'non':72 'non-negoti':71 'note':487,860 'oblig':358,880 'obvious':456 'one':575,628 'option':412,969 'origin':386 'outlin':1366 'output':542,1274,1365 'overrid':85,489 'packag':922 'page':337,1312 'paper':516,517,1013,1071,1136 'paramet':416,945,1221 'pars':736 'partial':897 'past':148 'path':226,821,1240 'pdf/markdown':527 'pdf/md':1003 'per':630 'person':307 'phase':539 'phrase':1038 'place':440 'placehold':178,185,284,718,1083,1089,1095,1110,1230,1305,1333 'prefer':96,551,1144 'previous':765 'prior':609,776 'proceed':751 'produc':62,1277 'progress':678 'proje':513 'project':13,45,50,122,149,511,538,571,602,625,777,1023,1078 'project-specif':624 'prose':20,388,464,707,818,902,927,954,975,1228 'provid':582,750 'pseudocod':22,157,163,1216 'pseudocode-on':21 'pure':64,254,924 'push':462 'py':228,1257 'qualiti':722,1123,1338 'rapor':504,510 'raporu':514 'rather':389,989 'raw':172 'read':48,681,726,794 'readabl':435,982 'reader':1264 'readm':1295 'real':186 'refer':26,70,712,769,1047,1052,1261,1292,1321 'reference/image-policy.md':1118,1119,1340,1341 'reference/repo-evidence-sources.md':1355,1356 'reference/requirements-mapping.md':1350,1351 'reference/style-baseline.md':1345,1346 'references.bib':1055 'relat':463,607 'relev':611,795 'remov':655 'repeat':968 'replac':1109 'report':4,11,32,40,66,89,155,206,221,248,251,277,381,502,506,549,588,595,676,704,766,817,835,878,913,1025,1161,1215,1237,1263 'repositori':326,1209 'request':106,497,1152 'requir':14,52,110,123,130,401,524,572,579,656,660,682,696,727,733,747,839,858,869,875,895,1352 'requirement-first':109 'requirement-to-sect':695,868 'requirement/assignment':354 'result':638,642,889 'rewrit':1024 'rule':74,77,476,1344 'run':80,721,1122 'scope':536,604 'screenshot':187,1116 'section':114,137,531,562,564,627,629,657,663,698,741,756,760,871,879 'see':1117,1125,1271,1367 'servic':324,1202 'set':420,970 'sever':441 'shadow':391 'short':993 'singular':308 'skeleton':1325,1329 'skill':47,201,495 'skill-awesome-ieee-report' 'small':978 'softwar':42 'sourc':143,150,350,525,796,1006,1018,1066,1074,1101,1243 'source-enesdemir143' 'space':459 'specif':626 'stack':620 'standard':135,585,754,1015 'statement':207 'status':650 'step':679,684,692,700,708,714,719,724,786,811,865,909,1048,1079,1120 'strategi':848 'strict':1234 'structur':138,239,563,589,757,761,847,1252 'style':395,781,1129,1348 'submit':296 'summari':648,949 'synthes':383 'system':260,614,1268 'tabl':405,427,943,956,979,997,1220 'table-first':404 'tables/figures':443 'target':535 'technic':10,31,39,501,587,1154 'technolog':619,1012,1062 'teknik':503 'templat':1319 'templates/figure-placeholders.md':1330,1331 'templates/report-template.md':1326,1327 'templates/report-template.tex':1322,1323 'term':499,1155,1180,1183,1186,1191 'test':639,888 'tex':545,1281 'text':249,675,836 'threshold':415,946,1222 'tone':292,1131 'topic-academic-writing' 'topic-agent-skill' 'topic-agent-skills' 'topic-ai-agent-skill' 'topic-bibtex' 'topic-claude-skills' 'topic-codex-skills' 'topic-ieee' 'topic-ieeeetran' 'topic-latex' 'topic-report-generator' 'topic-skill-md' 'ts':229,1258 'turkish':99,1149 'two':340,433,1316 'two-column':339,432,1315 'ui':891 'understand':799,840,1266 'university/company/department':558 'unless':81,369 'use':18,101,133,312,331,492,493,583,778,914,932,941,987,1020,1042,1075,1091,1148,1178,1184,1189,1282 'user':83,94,104,371,479,483,1141 'variabl':236 'vocabulari':314,323,1177 'white':458 'white-spac':457 'widget':327 'without':1269 'word':393 'work':265,608,647,652 'workflow':674 'would':980 'write':293,702,864,911,923,1128 'yaml':1259 'yazma':518 'zero':928","prices":[{"id":"e1603373-8e74-45f5-90e8-804d4c11cd0c","listingId":"c6b5194b-b859-4037-8947-d4aacf149805","amountUsd":"0","unit":"free","nativeCurrency":null,"nativeAmount":null,"chain":null,"payTo":null,"paymentMethod":"skill-free","isPrimary":true,"details":{"org":"EnesDemir143","category":"awesome-ieee-report","install_from":"skills.sh"},"createdAt":"2026-05-18T13:22:12.359Z"}],"sources":[{"listingId":"c6b5194b-b859-4037-8947-d4aacf149805","source":"github","sourceId":"EnesDemir143/awesome-ieee-report","sourceUrl":"https://github.com/EnesDemir143/awesome-ieee-report","isPrimary":false,"firstSeenAt":"2026-05-18T13:22:12.359Z","lastSeenAt":"2026-05-18T19:14:25.447Z"}],"details":{"listingId":"c6b5194b-b859-4037-8947-d4aacf149805","quickStartSnippet":null,"exampleRequest":null,"exampleResponse":null,"schema":null,"openapiUrl":null,"agentsTxtUrl":null,"citations":[],"useCases":[],"bestFor":[],"notFor":[],"kindDetails":{"org":"EnesDemir143","slug":"awesome-ieee-report","github":{"repo":"EnesDemir143/awesome-ieee-report","stars":6,"topics":["academic-writing","agent-skill","agent-skills","ai-agent-skill","bibtex","claude-skills","codex-skills","ieee","ieeeetran","latex","report-generator","skill-md","skillsmp","technical-report"],"license":"mit","html_url":"https://github.com/EnesDemir143/awesome-ieee-report","pushed_at":"2026-04-24T19:42:35Z","description":"An AI agent skill that generates IEEE-format LaTeX technical reports from your codebase — zero code artifacts, pseudocode only, BibTeX included.","skill_md_sha":"3e04cccfebecea2e0a840963dffe6dadf5300cd0","skill_md_path":"SKILL.md","default_branch":"main","skill_tree_url":"https://github.com/EnesDemir143/awesome-ieee-report"},"layout":"root","source":"github","category":"awesome-ieee-report","frontmatter":{"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."},"skills_sh_url":"https://skills.sh/EnesDemir143/awesome-ieee-report"},"updatedAt":"2026-05-18T19:14:25.447Z"}}