What are the responsibilities and job description for the Technical Writer Job at Ledgent Technology in Largo position at Ledgent Technology?
We are seeking technical writer candidates to present to our client in Largo, FL, for a contract to hire role. The position will be onsite daily.
The custom software lacks comprehensive documentation, creating challenges in understanding code functionality, business rules, and database structures. To address this, we aim to hire a technical writer to document the software systematically. This documentation will include technical / white papers for designated code modules, processes, business rules, table structures, and data dictionaries.
Project Objectives
- Provide clear, comprehensive documentation for the custom software.
- Facilitate knowledge transfer and ease onboarding for new team members.
- Enable efficient troubleshooting and software maintenance.
- Standardize and centralize all documentation for future scalability.
Scope of Work
Breakdown of all designated code modules.
Overview of software workflows.
Comprehensive list of business rules embedded in the code.
Table structures, including field definitions and data types.
Definitions of all database fields and their usage.
Approach and Methodology
Conduct initial meetings with IT and development teams to identify key areas requiring documentation.
Provide the technical writer with access to software, code repositories, and SMEs (Subject Matter Experts).
Follow a structured process :
Iterative review process involving IT leadership and SMEs.
Compile all documents into a central repository.
Desired Skills and Experience
Technical writer for custom software system - ASP.Net, C#, .Net
Seniority level
Mid-Senior level
Employment type
Full-time
Job function
Writing / Editing
Industries
Software Development, Technology, Information and Internet, and Technology, Information and Media
J-18808-Ljbffr
