{'fraction_non_alphanumeric': 0.021621621621621623, 'fraction_numerical': 0.0, 'mean_word_length': 5.465116279069767, 'pattern_counts': {'":': 0, '<': 0, '<?xml version=': 0, '>': 0, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
A catalogue of good practices for patterns writing

The activity of writing software patterns with quality presents itself especially as of high complexity. To support this activity, several works, including patterns, are available in the literature. Nevertheless, it is noticed that the documentation of patterns with quality remains an extremely difficult task, especially for beginners. In this context, this paper presents a set of best practices for documentation of software patterns, arranged as patterns, to complement the literature in this area.