codex-academic-paper-skills  by AAASS554

AI skills for software engineering thesis planning and revision

Created 1 month ago
282 stars

Top 92.4% on SourcePulse

GitHubView on GitHub
Project Summary

This package provides specialized skills for the Codex/Codex CLI, designed to automate and assist with common, high-frequency tasks in undergraduate software engineering thesis planning and revision. Targeting students who need to ground their theses in actual project repositories, it offers a structured approach to generating thesis outlines, refining drafts, reducing plagiarism and AI-generated content, recovering figures, supplementing with running screenshots, and finalizing documents according to institutional templates, thereby streamlining the academic writing process.

How It Works

The package integrates two core skills: academic-paper-strategist and academic-paper-composer. The strategist focuses on initial planning, mapping project evidence to thesis sections, creating keep/rewrite/delete matrices, analyzing report hotspots, planning necessary figures and screenshots, and preparing a handoff for the composer. The composer then takes a working draft and iteratively refines it, performing local text replacements, restoring legacy assets like database E-R diagrams and field descriptions, incorporating actual system running screenshots, and ensuring adherence to school-specific templates for final DOCX output. This methodology prioritizes writing based strictly on verifiable project evidence, planning before extensive revision, and supporting the salvage of hand-edited drafts.

Quick Start & Requirements

Installation involves copying the skills/academic-paper-strategist and skills/academic-paper-composer directories into your Codex skills directory (e.g., ~/.codex/skills/). The primary requirement is the Codex/Codex CLI tool itself. No other specific software, hardware, or dataset dependencies are detailed, though access to the project repository, existing drafts, and school templates is implied for effective use.

Highlighted Details

  • Emphasizes writing exclusively based on real project evidence (code, SQL, configurations, documentation) to prevent fabricated content.
  • Includes a "hand-edited draft salvage mode" to protect user modifications from accidental overwrites.
  • Prioritizes the recovery and reuse of existing, valid charts and diagrams over redrawing them.
  • Focuses revision efforts on high-impact "hotspot" sections identified in reports, rather than blind, full-document edits.
  • Incorporates explicit checks for final document formatting, including fonts, colors, styles, table font sizes, and table of contents anchors.

Maintenance & Community

The project is authored by JDWA (email: 1412800823@qq.com). It is noted as being organized and extended from the lishix520/academic-paper-skills repository, with a recommendation to retain source attribution. No other community channels, contributors, or sponsorships are mentioned.

Licensing & Compatibility

This repository is released under the MIT License. The MIT license is permissive, generally allowing for commercial use, modification, and distribution, including integration with closed-source projects, without significant copyleft restrictions.

Limitations & Caveats

The skills are specifically tailored for undergraduate software engineering theses. Their effectiveness is contingent upon the quality and availability of the underlying project repository and existing draft materials. The package functions as an extension for the Codex/Codex CLI, requiring familiarity with that toolset. Specific performance benchmarks or comparisons against alternative methods are not provided in the documentation.

Health Check
Last Commit

1 month ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
0
Star History
227 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.