top of page

Technical Writing Sample (XML)

This is a sample of my writing that I've adapted to the Extensible Markup Language (XML) model. It demonstrates the latest skill in my writing arsenal.


Person looking at a screen with code on it.

The Text


Getting Started


Signing Up: Users can sign up for Contenticate simply by picking a username and generating a password. Any user can also sign up via an existing Google account. Once the account is created, users can then activate 2FA in their profile settings if required.


Dashboard Overview:


After creating an account and logging in, users are directed to the Contenticate dashboard. If it's their first time here, they will see pop-up instructions on where to go and what to do. These can be closed at any time and will not reappear after the first log-in.


The top right corner of the dashboard displays the user's status (online, offline), the number of unread messages marked in red, and the user's name. Clicking the arrow next to the user's name will toggle a drop-down menu which displays the following:


  • My Projects: The list of projects the user is working on

  • My Company: Displays the company to which the user belongs

  • Edit Company Details: Allows the user to edit the details of their company

  • Edit User Profile: Here, the user can customize their profile by changing their personal information, adding images, activating light/dark mode, etc.

  • Log Out


The Text in XML


<?xml version="1.0" encoding="UTF-8"?>

<documentation>

<title>Contenticate User Guide</title>


<!-- Introduction -->

<introduction>

<paragraph>

Welcome to the Contenticate User Guide. In essence, Contenticate is a platform designed to help you create, edit, and publish captivating content across the board - simplifying the entire process!

</paragraph>

<paragraph>

Before we proceed to the user guide, let us introduce some of Contenticate's features and functionalities:

</paragraph>

</introduction>


<!-- Features -->

<features>

<feature>

<title>Navigable Dashboard</title>

<description>

It all starts here! Contenticate's user-friendly interface provides easy access to everything you need to up your content game. It's easy to handle, and it's mobile-friendly to boot!

</description>

</feature>


<feature>

<title>Full-On Content Management</title>

<description>

Say goodbye to constantly copy-pasting and moving content around. Do things straight from the platform: create, edit, and organize cross-product content before scheduling it for publication.

</description>

</feature>


<feature>

<title>Hassle-Free Publishing</title>

<description>

Schedule publication dates, select your preferred social platforms, preview things before publishing them, and publish away once the light turns green.

</description>

</feature>


<feature>

<title>Analytics and Insights</title>

<description>

What's the point of content if you don't know how well it does? Use Contenticate's tools to analyze performance and engagement rates, and integrate third-party tools to take things to the next level.

</description>

</feature>


<feature>

<title>Collaboration Tools</title>

<description>

Instead of sending things back and forth for reviews and comments from colleagues, add them to your projects using our real-time collaboration feature!

</description>

</feature>


<feature>

<title>User Permissions</title>

<description>

Prevent the "Who deleted this?" drama by assigning specific roles and permissions to users, so everyone can contribute correctly to each project.

</description>

</feature>

</features>


<!-- Getting Started -->

<getting_started>

<section>

<title>Signing Up</title>

<description>

Users can sign up for Contenticate simply by picking a username and generating a password. Any user can also sign up via an existing Google account. Once the account is created, users can then activate 2FA in their profile settings if required.

</description>

</section>


<section>

<title>Dashboard Overview</title>

<description>

After creating an account and logging in, users are directed to the Contenticate dashboard. If it's their first time here, they will see pop-up instructions on where to go and what to do. These can be closed at any time and will not reappear after the first log-in.

</description>


<subsection>

<title>Top Right Corner Features</title>

<description>

The top right corner of the dashboard displays the user's status (online, offline), the number of unread messages marked in red, and the user's name. Clicking the arrow next to the user's name will toggle a drop-down menu which displays the following:

</description>


<list>

<item>My Projects: The list of projects the user is working on</item>

<item>My Company: Displays the company to which the user belongs</item>

<item>Edit Company Details: Allows the user to edit the details of their company</item>

<item>Edit User Profile: Here, the user can customize their profile by changing their personal information, adding images, activating light/dark mode, etc.</item>

<item>Log Out</item>

</list>

</subsection>

</section>

</getting_started>


</documentation>


17 views0 comments

Recent Posts

See All

Comments


bottom of page