PCGen Documentation Style Guide

Introduction

This page is being developed as a formal 'Style Guide' for the creation of documentation for PCGen. As this guide is still under development, please use PCGen's existing Documentation Standards.

What's in This Guide

TBD

Editorial Resources

TBD

Conventions Used

TBD

Document Notation

General Considerations

TBD

LST Tag Standard

All LST Tag documentation shall comply with the PCGen LST Tag Documentation Standard.

Code

TBD

Syntax Descriptions

TBD

Code Font in Text

TBD

Metasymbols in Text

TBD

Style and Usage

Numeric and Punctuation

A

B

C

D

E

F

G

H

I

J

K

L

M

N

O

P

Q

R

S

T

U

V

W

X

Y

Z

---

Source: PCGen Documentation Style Guide (original PCGen wiki)